Documentation Powered by ReDoc

Kibo ProductAdmin Service (v1)

Download OpenAPI specification:Download

Authentication

bearerAuth

JWT Authorization header using the Bearer scheme.

Enter 'Bearer' [space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

clientOauth2

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: /platform/applications/internal/access-tokens/oauth/
Scopes:

    Attribute

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable
    responseGroups
    string Nullable

    Responses

    Request samples 

    require('mozu-node-sdk/clients/content/documentlists/document')().getDocuments({
    pageSize: 5,
    documentListName: 'files@mozu'
}, {
    timeout: 60000
});

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Add / Create Attribute

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    adminName
    string Nullable

    Name of the product displayed in the admin, This field does not need to be unqiue, but is required. It can include spaces...and is limited to a length of 50.

    namespace
    string Nullable

    NameSpace, each application creating attributes will have a uniqe namespace to avoid name (Code) collisions. The namespace provided must be a valid registered namespace. If no namespace is specified it is assumed to be the namespace of the Tenant.

    attributeCode
    string Nullable

    Unique identifier of the Attribute. Must be unique within a namespace and cannot be changed once the attribute is created. This value will be generated and match the attribute sequence if not provided on create.

    attributeFQN
    string Nullable

    Attribute fully qualified name, Read only value that combines namespace and attribute code as NameSpace~AttributeCode

    isValueMappingAttribute
    boolean Nullable

    Specifies if this attribute can can be used to generalize values of another attribute

    valueMappingAttributeFQN
    string Nullable

    Attribute fully qualified name of a corresponding value mapping atribuite

    attributeSequence
    integer <int32> Nullable

    Read only System generated monotonically increasing unique sequence for each attribute created.

    attributeDataTypeSequence
    integer <int32> Nullable

    Read only System generated monotonically increasing unique sequence for each attribute,DataType created (this is used to optimize indexed field names in search).

    masterCatalogId
    integer <int32> Nullable

    Indentifier of the master that this attribute is a member of. System-supplied and read-only. Attributes will be created in the MasterCatalog of the supplied context.

    inputType
    string <= 20 characters Nullable

    The InputType type of the attribute. Must be a valid value for InputType defined in InputTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create

    valueType
    string <= 20 characters Nullable

    The ValueType of the attribute. Must be a valid value for ValueType defined in ValueTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create

    dataType
    string <= 20 characters Nullable

    The DataType of the attribute. Must be a valid value for DataType defined in DataTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create

    isOption
    boolean Nullable

    Specifies if this attribute can have a usage type of Option in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource.

    isExtra
    boolean Nullable

    Specifies if this attribute can have a usage type of Extra in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource.

    isProperty
    boolean Nullable

    Specifies if this attribute can have a usage type of Property in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource.

    Array of objects (AttributeMetadataItem) Nullable

    Attribute Metadata. This list can contain opaque data (key value pairs) that can be used as a property bag for UI concerns.

    object (AttributeLocalizedContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally.

    Array of objects (AttributeLocalizedContent) Nullable

    The Content of an attribute. This content is always in the default language of the MasterCatalog.

    object (AttributeValidation)

    Used to validate attributes.

    Array of objects (AttributeVocabularyValue) Nullable

    The list of Values for this attribute. Only available for ValueType:PredefinedVocabulary

    object (AttributeSearchSettings)

    Attribute Search Settings. A container for all of the search and indexing settings of an Attribute

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "adminName": "string",
    • "namespace": "string",
    • "attributeCode": "string",
    • "attributeFQN": "string",
    • "isValueMappingAttribute": true,
    • "valueMappingAttributeFQN": "string",
    • "attributeSequence": 0,
    • "attributeDataTypeSequence": 0,
    • "masterCatalogId": 0,
    • "inputType": "string",
    • "valueType": "string",
    • "dataType": "string",
    • "isOption": true,
    • "isExtra": true,
    • "isProperty": true,
    • "attributeMetadata": [
      ],
    • "content": {
      },
    • "localizedContent": [
      ],
    • "validation": {
      },
    • "vocabularyValues": [
      ],
    • "searchSettings": {
      },
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "adminName": "string",
    • "namespace": "string",
    • "attributeCode": "string",
    • "attributeFQN": "string",
    • "isValueMappingAttribute": true,
    • "valueMappingAttributeFQN": "string",
    • "attributeSequence": 0,
    • "attributeDataTypeSequence": 0,
    • "masterCatalogId": 0,
    • "inputType": "string",
    • "valueType": "string",
    • "dataType": "string",
    • "isOption": true,
    • "isExtra": true,
    • "isProperty": true,
    • "attributeMetadata": [
      ],
    • "content": {
      },
    • "localizedContent": [
      ],
    • "validation": {
      },
    • "vocabularyValues": [
      ],
    • "searchSettings": {
      },
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    query Parameters
    responseGroups
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "adminName": "string",
    • "namespace": "string",
    • "attributeCode": "string",
    • "attributeFQN": "string",
    • "isValueMappingAttribute": true,
    • "valueMappingAttributeFQN": "string",
    • "attributeSequence": 0,
    • "attributeDataTypeSequence": 0,
    • "masterCatalogId": 0,
    • "inputType": "string",
    • "valueType": "string",
    • "dataType": "string",
    • "isOption": true,
    • "isExtra": true,
    • "isProperty": true,
    • "attributeMetadata": [
      ],
    • "content": {
      },
    • "localizedContent": [
      ],
    • "validation": {
      },
    • "vocabularyValues": [
      ],
    • "searchSettings": {
      },
    • "auditInfo": {
      }
    }

    Update attribute

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    adminName
    string Nullable

    Name of the product displayed in the admin, This field does not need to be unqiue, but is required. It can include spaces...and is limited to a length of 50.

    namespace
    string Nullable

    NameSpace, each application creating attributes will have a uniqe namespace to avoid name (Code) collisions. The namespace provided must be a valid registered namespace. If no namespace is specified it is assumed to be the namespace of the Tenant.

    attributeCode
    string Nullable

    Unique identifier of the Attribute. Must be unique within a namespace and cannot be changed once the attribute is created. This value will be generated and match the attribute sequence if not provided on create.

    attributeFQN
    string Nullable

    Attribute fully qualified name, Read only value that combines namespace and attribute code as NameSpace~AttributeCode

    isValueMappingAttribute
    boolean Nullable

    Specifies if this attribute can can be used to generalize values of another attribute

    valueMappingAttributeFQN
    string Nullable

    Attribute fully qualified name of a corresponding value mapping atribuite

    attributeSequence
    integer <int32> Nullable

    Read only System generated monotonically increasing unique sequence for each attribute created.

    attributeDataTypeSequence
    integer <int32> Nullable

    Read only System generated monotonically increasing unique sequence for each attribute,DataType created (this is used to optimize indexed field names in search).

    masterCatalogId
    integer <int32> Nullable

    Indentifier of the master that this attribute is a member of. System-supplied and read-only. Attributes will be created in the MasterCatalog of the supplied context.

    inputType
    string <= 20 characters Nullable

    The InputType type of the attribute. Must be a valid value for InputType defined in InputTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create

    valueType
    string <= 20 characters Nullable

    The ValueType of the attribute. Must be a valid value for ValueType defined in ValueTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create

    dataType
    string <= 20 characters Nullable

    The DataType of the attribute. Must be a valid value for DataType defined in DataTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create

    isOption
    boolean Nullable

    Specifies if this attribute can have a usage type of Option in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource.

    isExtra
    boolean Nullable

    Specifies if this attribute can have a usage type of Extra in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource.

    isProperty
    boolean Nullable

    Specifies if this attribute can have a usage type of Property in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource.

    Array of objects (AttributeMetadataItem) Nullable

    Attribute Metadata. This list can contain opaque data (key value pairs) that can be used as a property bag for UI concerns.

    object (AttributeLocalizedContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally.

    Array of objects (AttributeLocalizedContent) Nullable

    The Content of an attribute. This content is always in the default language of the MasterCatalog.

    object (AttributeValidation)

    Used to validate attributes.

    Array of objects (AttributeVocabularyValue) Nullable

    The list of Values for this attribute. Only available for ValueType:PredefinedVocabulary

    object (AttributeSearchSettings)

    Attribute Search Settings. A container for all of the search and indexing settings of an Attribute

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "adminName": "string",
    • "namespace": "string",
    • "attributeCode": "string",
    • "attributeFQN": "string",
    • "isValueMappingAttribute": true,
    • "valueMappingAttributeFQN": "string",
    • "attributeSequence": 0,
    • "attributeDataTypeSequence": 0,
    • "masterCatalogId": 0,
    • "inputType": "string",
    • "valueType": "string",
    • "dataType": "string",
    • "isOption": true,
    • "isExtra": true,
    • "isProperty": true,
    • "attributeMetadata": [
      ],
    • "content": {
      },
    • "localizedContent": [
      ],
    • "validation": {
      },
    • "vocabularyValues": [
      ],
    • "searchSettings": {
      },
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "adminName": "string",
    • "namespace": "string",
    • "attributeCode": "string",
    • "attributeFQN": "string",
    • "isValueMappingAttribute": true,
    • "valueMappingAttributeFQN": "string",
    • "attributeSequence": 0,
    • "attributeDataTypeSequence": 0,
    • "masterCatalogId": 0,
    • "inputType": "string",
    • "valueType": "string",
    • "dataType": "string",
    • "isOption": true,
    • "isExtra": true,
    • "isProperty": true,
    • "attributeMetadata": [
      ],
    • "content": {
      },
    • "localizedContent": [
      ],
    • "validation": {
      },
    • "vocabularyValues": [
      ],
    • "searchSettings": {
      },
    • "auditInfo": {
      }
    }

    Delete attribute

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    localeCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "name": "string",
    • "description": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    localeCode
    required
    string Nullable
    Request Body schema: application/json
    localeCode
    string Nullable

    Language used for the attribute name and description. Currently, only en_US is supported.

    name
    string Nullable

    Name of the attribute in the language specified by LocaleCode.

    description
    string Nullable

    Description of the attribute in the language specified by LocaleCode.

    Responses

    Request samples

    Content type
    application/json
    {
    • "localeCode": "string",
    • "name": "string",
    • "description": "string"
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "name": "string",
    • "description": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    localeCode
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    localeCode
    string Nullable

    Language used for the attribute name and description. Currently, only en_US is supported.

    name
    string Nullable

    Name of the attribute in the language specified by LocaleCode.

    description
    string Nullable

    Description of the attribute in the language specified by LocaleCode.

    Responses

    Request samples

    Content type
    application/json
    {
    • "localeCode": "string",
    • "name": "string",
    • "description": "string"
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "name": "string",
    • "description": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    localeCode
    string Nullable

    Language used for the attribute name and description. Currently, only en_US is supported.

    name
    string Nullable

    Name of the attribute in the language specified by LocaleCode.

    description
    string Nullable

    Description of the attribute in the language specified by LocaleCode.

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "valueSequence": 0,
    • "value": { },
    • "mappedGenericValues": [
      ],
    • "productName": "string",
    • "content": {
      },
    • "localizedContent": [
      ],
    • "displayOrder": 0
    }

    Update attribute vocabulary value

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    Request Body schema: application/json
    valueSequence
    integer <int32> Nullable

    Read only System generated monotonically increasing unique sequence.

    object Nullable

    The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed.

    Array of objects Nullable

    The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time.

    productName
    string Nullable

    The ProductName when the Attribute DataType is ProductCode.

    object (AttributeVocabularyValueLocalizedContent)

    Attribute Value Localized Resource

    Array of objects (AttributeVocabularyValueLocalizedContent) Nullable

    The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType.

    displayOrder
    integer <int32> Nullable

    The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list.

    Responses

    Request samples

    Content type
    application/json
    {
    • "valueSequence": 0,
    • "value": { },
    • "mappedGenericValues": [
      ],
    • "productName": "string",
    • "content": {
      },
    • "localizedContent": [
      ],
    • "displayOrder": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "valueSequence": 0,
    • "value": { },
    • "mappedGenericValues": [
      ],
    • "productName": "string",
    • "content": {
      },
    • "localizedContent": [
      ],
    • "displayOrder": 0
    }

    Delete Attribute Vocabulary Value

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    localeCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    localeCode
    required
    string Nullable
    Request Body schema: application/json
    localeCode
    string Nullable

    Language used for the string attribute value. Currently, only en_US is supported.

    stringValue
    string Nullable

    Localized Value in the language of the locale code

    Responses

    Request samples

    Content type
    application/json
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    localeCode
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    Request Body schema: application/json
    localeCode
    string Nullable

    Language used for the string attribute value. Currently, only en_US is supported.

    stringValue
    string Nullable

    Localized Value in the language of the locale code

    Responses

    Request samples

    Content type
    application/json
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    query Parameters
    responseGroups
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    Add attribute vocabulary value

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    valueSequence
    integer <int32> Nullable

    Read only System generated monotonically increasing unique sequence.

    object Nullable

    The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed.

    Array of objects Nullable

    The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time.

    productName
    string Nullable

    The ProductName when the Attribute DataType is ProductCode.

    object (AttributeVocabularyValueLocalizedContent)

    Attribute Value Localized Resource

    Array of objects (AttributeVocabularyValueLocalizedContent) Nullable

    The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType.

    displayOrder
    integer <int32> Nullable

    The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list.

    Responses

    Request samples

    Content type
    application/json
    {
    • "valueSequence": 0,
    • "value": { },
    • "mappedGenericValues": [
      ],
    • "productName": "string",
    • "content": {
      },
    • "localizedContent": [
      ],
    • "displayOrder": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "valueSequence": 0,
    • "value": { },
    • "mappedGenericValues": [
      ],
    • "productName": "string",
    • "content": {
      },
    • "localizedContent": [
      ],
    • "displayOrder": 0
    }

    Update attribute vocabulary values

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    valueSequence
    integer <int32> Nullable

    Read only System generated monotonically increasing unique sequence.

    object Nullable

    The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed.

    Array of objects Nullable

    The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time.

    productName
    string Nullable

    The ProductName when the Attribute DataType is ProductCode.

    object (AttributeVocabularyValueLocalizedContent)

    Attribute Value Localized Resource

    Array of objects (AttributeVocabularyValueLocalizedContent) Nullable

    The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType.

    displayOrder
    integer <int32> Nullable

    The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list.

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    Request Body schema: application/json
    localeCode
    string Nullable

    Language used for the string attribute value. Currently, only en_US is supported.

    stringValue
    string Nullable

    Localized Value in the language of the locale code

    Responses

    Request samples

    Content type
    application/json
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    Retrieves a paged list of attribute type rules according to any specified filter criteria and sort options.

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional.

    pageSize
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.

    sortBy
    string Nullable

    The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

    filter
    string Nullable

    A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Category

    Retrieves a list of categories according to any specified filter criteria and sort options.

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. The default value is 0.

    pageSize
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200.

    sortBy
    string Nullable

    The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order.

    filter
    string Nullable

    A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

    responseGroups
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Adds a new category to the catalog's category hierarchy. Specify a ParentCategoryID to determine where to locate the category in the hierarchy; if not specified it becomes a top-level category.

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    incrementSequence
    boolean
    Default: false

    Sets the sequence number of the category to the current max sequence value plus 1 (e.g. 5 + 1 = 6)

    useProvidedId
    boolean
    Default: false

    If true, the provided Id value will be used as the CategoryId. If omitted or false, the system will generate a CategoryId

    Request Body schema: application/json

    Properties of the new category. Required properties ParentCategoryID and Content.Name.

    id
    integer <int32> Nullable

    Internal unique identifier of the category. System-supplied and read-only.

    categoryType
    string Nullable

    The Type of Category Static, Dyanmic, DynamicPreComputed

    catalogId
    integer <int32> Nullable

    The CatalogId that the category belongs to.

    parentCategoryId
    integer <int32> Nullable

    Unique identifier of the category to which this category belongs. If nil, this is a top-level category. System-supplied and read-only.

    parentCategoryCode
    string Nullable
    parentCategoryName
    string Nullable
    parentIsActive
    boolean Nullable
    categoryCode
    string Nullable

    External unique identifier of the category.

    isActive
    boolean Nullable

    If false, the category is considered unavailable in runtime (default is true if not specified on create)

    isDisplayed
    boolean Nullable

    If true, the category appears to shoppers on the storefront.

    sequence
    integer <int32> Nullable

    Order in which categories appear when they are at the same level (siblings). For example, you could change the sequence of categories so that a specific category always appears first.

    object (CategoryLocalizedContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a category in multiple languages yet manage it as a single category internally.

    object (DynamicExpression)

    Category

    productCount
    integer <int32> Nullable

    Number of products contained in this category. This count includes all products contained in any subcategories of this category.

    childCount
    integer <int32> Nullable

    Number of subcategories that belong to this category. These subcategories are at the same level (siblings).

    object (AuditInfo)
    shouldSlice
    boolean Nullable

    If True, search displays sliced view

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": 0,
    • "categoryType": "string",
    • "catalogId": 0,
    • "parentCategoryId": 0,
    • "parentCategoryCode": "string",
    • "parentCategoryName": "string",
    • "parentIsActive": true,
    • "categoryCode": "string",
    • "isActive": true,
    • "isDisplayed": true,
    • "sequence": 0,
    • "content": {
      },
    • "dynamicExpression": {
      },
    • "productCount": 0,
    • "childCount": 0,
    • "auditInfo": {
      },
    • "shouldSlice": true
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "categoryType": "string",
    • "catalogId": 0,
    • "parentCategoryId": 0,
    • "parentCategoryCode": "string",
    • "parentCategoryName": "string",
    • "parentIsActive": true,
    • "categoryCode": "string",
    • "isActive": true,
    • "isDisplayed": true,
    • "sequence": 0,
    • "content": {
      },
    • "dynamicExpression": {
      },
    • "productCount": 0,
    • "childCount": 0,
    • "auditInfo": {
      },
    • "shouldSlice": true
    }

    Retrieves the details of a single category.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    categoryId
    required
    integer <int32>

    Unique identifier of the category.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "categoryType": "string",
    • "catalogId": 0,
    • "parentCategoryId": 0,
    • "parentCategoryCode": "string",
    • "parentCategoryName": "string",
    • "parentIsActive": true,
    • "categoryCode": "string",
    • "isActive": true,
    • "isDisplayed": true,
    • "sequence": 0,
    • "content": {
      },
    • "dynamicExpression": {
      },
    • "productCount": 0,
    • "childCount": 0,
    • "auditInfo": {
      },
    • "shouldSlice": true
    }

    Modifies a category such as moving it to another location in the category tree, or changing whether it is visible on the storefront. This PUT replaces the existing resource, so be sure to include all the information that you want to maintain for the category. Any unspecified properties are set to null.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    categoryId
    required
    integer <int32>

    Unique identifier of the category that you want to modify. Required.

    query Parameters
    cascadeVisibility
    boolean
    Default: false

    If true, when changing the display option for the category, change it for all subcategories also. Optional.

    Request Body schema: application/json

    Properties of the category that you want to modify. Required properties ParentCategoryID and Content.Name.

    id
    integer <int32> Nullable

    Internal unique identifier of the category. System-supplied and read-only.

    categoryType
    string Nullable

    The Type of Category Static, Dyanmic, DynamicPreComputed

    catalogId
    integer <int32> Nullable

    The CatalogId that the category belongs to.

    parentCategoryId
    integer <int32> Nullable

    Unique identifier of the category to which this category belongs. If nil, this is a top-level category. System-supplied and read-only.

    parentCategoryCode
    string Nullable
    parentCategoryName
    string Nullable
    parentIsActive
    boolean Nullable
    categoryCode
    string Nullable

    External unique identifier of the category.

    isActive
    boolean Nullable

    If false, the category is considered unavailable in runtime (default is true if not specified on create)

    isDisplayed
    boolean Nullable

    If true, the category appears to shoppers on the storefront.

    sequence
    integer <int32> Nullable

    Order in which categories appear when they are at the same level (siblings). For example, you could change the sequence of categories so that a specific category always appears first.

    object (CategoryLocalizedContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a category in multiple languages yet manage it as a single category internally.

    object (DynamicExpression)

    Category

    productCount
    integer <int32> Nullable

    Number of products contained in this category. This count includes all products contained in any subcategories of this category.

    childCount
    integer <int32> Nullable

    Number of subcategories that belong to this category. These subcategories are at the same level (siblings).

    object (AuditInfo)
    shouldSlice
    boolean Nullable

    If True, search displays sliced view

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": 0,
    • "categoryType": "string",
    • "catalogId": 0,
    • "parentCategoryId": 0,
    • "parentCategoryCode": "string",
    • "parentCategoryName": "string",
    • "parentIsActive": true,
    • "categoryCode": "string",
    • "isActive": true,
    • "isDisplayed": true,
    • "sequence": 0,
    • "content": {
      },
    • "dynamicExpression": {
      },
    • "productCount": 0,
    • "childCount": 0,
    • "auditInfo": {
      },
    • "shouldSlice": true
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "categoryType": "string",
    • "catalogId": 0,
    • "parentCategoryId": 0,
    • "parentCategoryCode": "string",
    • "parentCategoryName": "string",
    • "parentIsActive": true,
    • "categoryCode": "string",
    • "isActive": true,
    • "isDisplayed": true,
    • "sequence": 0,
    • "content": {
      },
    • "dynamicExpression": {
      },
    • "productCount": 0,
    • "childCount": 0,
    • "auditInfo": {
      },
    • "shouldSlice": true
    }

    Deletes the category specified by its category ID.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    categoryId
    required
    integer <int32>

    Unique identifier of the category that you want to delete.

    query Parameters
    cascadeDelete
    boolean
    Default: false

    If true, any subcategories of a category are deleted when this category is deleted. Otherwise only the given category is deleted. Default is false.

    forceDelete
    boolean
    Default: false

    If true, category (and optionally subcategories) will be deleted even if there are products referecing them. Default is false.

    reassignToParent
    boolean
    Default: false

    If true, and child categories of the given category will be reassigned to the parent of the given category. Only applies if cascadeDelete is false. Default is false.

    Responses

    Retrieves the immediate subcategories of a category. This is a list of subcategories at the same level (siblings). You can use a list of siblings, for example, to display the categories in a horizontal list.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    categoryId
    required
    integer <int32>

    Unique identifier of the category whose subcategories you want to get.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    text
    string Nullable
    object (Expression)

    Responses

    Request samples

    Content type
    application/json
    {
    • "text": "string",
    • "tree": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "text": "string",
    • "tree": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    text
    string Nullable
    object (Expression)

    Responses

    Request samples

    Content type
    application/json
    {
    • "text": "string",
    • "tree": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "text": "string",
    • "tree": {
      }
    }

    Removes the products in the provided product code list from the specified category.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    categoryId
    required
    integer <int32>

    Unique identifier of the category that you want products removed from.

    Request Body schema: application/json

    A list of products to be removed from the category.

    Array ()
    string

    Responses

    Request samples

    Content type
    application/json
    [
    • "string"
    ]

    Adds the products in the provided product code list to the specified category.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    categoryId
    required
    integer <int32>

    Unique identifier of the category that you want produts added to.

    Request Body schema: application/json

    A list of products to be added to the category.

    Array ()
    string

    Responses

    Request samples

    Content type
    application/json
    [
    • "string"
    ]

    CoreFields

    <no summary>

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    CouponSet

    Returns a random 4 character code that is unique as a coupon set code.

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    "string"

    Tests code for uniqueness and validity

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    code
    string Nullable

    Responses

    Returns a single Mozu.ProductAdmin.Contracts.CouponSet

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable

    CouponSetCode for the requested CouponSet

    query Parameters
    includeCounts
    boolean
    Default: false

    Include the redemption counts and coupon counts

    responseGroups
    string Nullable

    "counts" includes the number of redemptions, coupon codes, and assigned discounts.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "couponSetCode": "string",
    • "name": "string",
    • "couponCodeType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "maxRedemptionsPerUser": 0,
    • "maxRedemptionsPerCouponCode": 0,
    • "endDate": "2019-08-24T14:15:22Z",
    • "startDate": "2019-08-24T14:15:22Z",
    • "auditInfo": {
      },
    • "setSize": 0,
    • "couponCodeCount": 0,
    • "redemptionCount": 0,
    • "assignedDiscountCount": 0
    }

    Update a Mozu.ProductAdmin.Contracts.CouponSet representation. You can not update the Code or ID once the set is created.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable
    Request Body schema: application/json
    id
    integer <int32> Nullable

    Internal unique identifier of the couponset. System-supplied and read-only.

    couponSetCode
    string <= 32 characters Nullable

    Unique tenant supplied identifier. Used as the prefix for generated sets. Required System generated if left null.

    name
    required
    string <= 200 characters

    CouponSet Name

    couponCodeType
    string Nullable

    Determines if the coupon is a persisted list of codes (static) or a list based on generated specification (dynamic).

    status
    string Nullable

    CouponSet status which can be: Active, Expired, Inactive System-supplied and read-only.

    canBeDeleted
    boolean

    Signifies that the coupon has not been exported and can be updated ReadOnly

    maxRedemptionsPerUser
    integer <int32> Nullable

    Maximum number of times any single user can redeem any code. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited.

    maxRedemptionsPerCouponCode
    integer <int32> Nullable

    Maximum number of times any code can de used. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited.

    endDate
    string <date-time> Nullable

    Date and time that the coupon codes becomes expired

    startDate
    string <date-time> Nullable

    Date and time that the coupon codes becomes active

    object (AuditInfo)
    setSize
    integer <int32> Nullable

    Sets the number of codes to generate for dynamic coupons Required when CouponCodeType is "Dynamic"

    couponCodeCount
    integer <int32> Nullable

    Count of associated couponCodes. Must use "counts" response group to get this value ReadOnly

    redemptionCount
    integer <int32> Nullable

    ReadOnly count of all redemptions for this coupon set.

    assignedDiscountCount
    integer <int32> Nullable

    ReadOnly sum of all redemptions for this coupon. Use "counts" response group.

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": 0,
    • "couponSetCode": "string",
    • "name": "string",
    • "couponCodeType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "maxRedemptionsPerUser": 0,
    • "maxRedemptionsPerCouponCode": 0,
    • "endDate": "2019-08-24T14:15:22Z",
    • "startDate": "2019-08-24T14:15:22Z",
    • "auditInfo": {
      },
    • "setSize": 0,
    • "couponCodeCount": 0,
    • "redemptionCount": 0,
    • "assignedDiscountCount": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "couponSetCode": "string",
    • "name": "string",
    • "couponCodeType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "maxRedemptionsPerUser": 0,
    • "maxRedemptionsPerCouponCode": 0,
    • "endDate": "2019-08-24T14:15:22Z",
    • "startDate": "2019-08-24T14:15:22Z",
    • "auditInfo": {
      },
    • "setSize": 0,
    • "couponCodeCount": 0,
    • "redemptionCount": 0,
    • "assignedDiscountCount": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable

    Responses

    Returns a paged collection of CouponSets

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable
    includeCounts
    boolean
    Default: false

    Include coupon and redemption counts

    responseGroups
    string Nullable

    "counts" returns discount and couponCode counts

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Adds a single Mozu.ProductAdmin.Contracts.CouponSet

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    id
    integer <int32> Nullable

    Internal unique identifier of the couponset. System-supplied and read-only.

    couponSetCode
    string <= 32 characters Nullable

    Unique tenant supplied identifier. Used as the prefix for generated sets. Required System generated if left null.

    name
    required
    string <= 200 characters

    CouponSet Name

    couponCodeType
    string Nullable

    Determines if the coupon is a persisted list of codes (static) or a list based on generated specification (dynamic).

    status
    string Nullable

    CouponSet status which can be: Active, Expired, Inactive System-supplied and read-only.

    canBeDeleted
    boolean

    Signifies that the coupon has not been exported and can be updated ReadOnly

    maxRedemptionsPerUser
    integer <int32> Nullable

    Maximum number of times any single user can redeem any code. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited.

    maxRedemptionsPerCouponCode
    integer <int32> Nullable

    Maximum number of times any code can de used. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited.

    endDate
    string <date-time> Nullable

    Date and time that the coupon codes becomes expired

    startDate
    string <date-time> Nullable

    Date and time that the coupon codes becomes active

    object (AuditInfo)
    setSize
    integer <int32> Nullable

    Sets the number of codes to generate for dynamic coupons Required when CouponCodeType is "Dynamic"

    couponCodeCount
    integer <int32> Nullable

    Count of associated couponCodes. Must use "counts" response group to get this value ReadOnly

    redemptionCount
    integer <int32> Nullable

    ReadOnly count of all redemptions for this coupon set.

    assignedDiscountCount
    integer <int32> Nullable

    ReadOnly sum of all redemptions for this coupon. Use "counts" response group.

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": 0,
    • "couponSetCode": "string",
    • "name": "string",
    • "couponCodeType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "maxRedemptionsPerUser": 0,
    • "maxRedemptionsPerCouponCode": 0,
    • "endDate": "2019-08-24T14:15:22Z",
    • "startDate": "2019-08-24T14:15:22Z",
    • "auditInfo": {
      },
    • "setSize": 0,
    • "couponCodeCount": 0,
    • "redemptionCount": 0,
    • "assignedDiscountCount": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "couponSetCode": "string",
    • "name": "string",
    • "couponCodeType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "maxRedemptionsPerUser": 0,
    • "maxRedemptionsPerCouponCode": 0,
    • "endDate": "2019-08-24T14:15:22Z",
    • "startDate": "2019-08-24T14:15:22Z",
    • "auditInfo": {
      },
    • "setSize": 0,
    • "couponCodeCount": 0,
    • "redemptionCount": 0,
    • "assignedDiscountCount": 0
    }

    Returns a paged collection of Coupons

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable
    includeCounts
    boolean
    Default: false

    Includes coupon redemption counts

    responseGroups
    string Nullable

    counts

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    couponSetId
    integer <int32>

    ReadOnly system id for releated couponset.

    couponSetCode
    string Nullable

    Link to associated coupon

    couponCode
    required
    string

    The code the customer uses to claim this coupon

    canBeDeleted
    boolean
    redemptionCount
    integer <int32> Nullable

    Total number of times this code has been redeemed. ReadOnly, calculated. Only returned with response group includeCounts

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable
    couponCode
    required
    string Nullable
    query Parameters
    includeCounts
    boolean
    Default: false
    responseGroups
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "couponSetId": 0,
    • "couponSetCode": "string",
    • "couponCode": "string",
    • "canBeDeleted": true,
    • "redemptionCount": 0,
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable
    couponCode
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    string

    Responses

    Request samples

    Content type
    application/json
    [
    • "string"
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable
    Request Body schema: application/json
    couponSetCode
    string Nullable

    ReadOnly, CouponSetCode copied from URI

    couponSetId
    integer <int32>

    ReadOnly, CouponSetId

    discountId
    required
    integer <int32>

    Discount Id for the associated discount

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "couponSetCode": "string",
    • "couponSetId": 0,
    • "discountId": 0,
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    couponSetCode
    required
    string Nullable
    discountId
    required
    integer <int32>

    Responses

    Currency

    Adds a new product sort definition.

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json

    Properties of the currency-localization to create. Required properties: CurrencyCode

    currencyCode
    string Nullable

    Currency Code

    decimalPlaces
    integer <int32> Nullable

    Number of decimal places to round to

    roundingStrategy
    integer <int32> Nullable

    The rounding strategy to use

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "currencyCode": "string",
    • "decimalPlaces": 0,
    • "roundingStrategy": 0,
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "decimalPlaces": 0,
    • "roundingStrategy": 0,
    • "auditInfo": {
      }
    }

    Gets all currency-localizations.

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    Deletes the currency-localization specified by its currency code.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    currencyCode
    required
    string Nullable

    Currency code.

    Responses

    Gets a single currency-localization.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    currencyCode
    required
    string Nullable

    Currency code.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "decimalPlaces": 0,
    • "roundingStrategy": 0,
    • "auditInfo": {
      }
    }

    Updates the details of a currency-localization.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    currencyCode
    required
    string Nullable

    Currency code.

    Request Body schema: application/json

    Properties of the currency-localization to update.

    currencyCode
    string Nullable

    Currency Code

    decimalPlaces
    integer <int32> Nullable

    Number of decimal places to round to

    roundingStrategy
    integer <int32> Nullable

    The rounding strategy to use

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "currencyCode": "string",
    • "decimalPlaces": 0,
    • "roundingStrategy": 0,
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "decimalPlaces": 0,
    • "roundingStrategy": 0,
    • "auditInfo": {
      }
    }

    Add multiple exchange rates for a specified currency-code.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    currencyCode
    required
    string Nullable

    Currency code

    Request Body schema: application/json

    Exchange rates for the currency

    Array ()
    fromCurrencyCode
    string Nullable

    The source currency code

    toCurrencyCode
    string Nullable

    The target currency code

    rate
    required
    number <double>

    The exchange rate

    multiplier
    number <double> Nullable

    An additional multiplier to use in calculations

    referenceData
    string Nullable

    Reference data for miscellaneous metadata from updates

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieves a list of exchange rates for a specified currency-code and filter criteria.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    currencyCode
    required
    string Nullable

    Currency code

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    Update multiple exchange rates for a specified currency-code.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    currencyCode
    required
    string Nullable

    Currency code

    Request Body schema: application/json

    Exchange rates for the currency

    Array ()
    fromCurrencyCode
    string Nullable

    The source currency code

    toCurrencyCode
    string Nullable

    The target currency code

    rate
    required
    number <double>

    The exchange rate

    multiplier
    number <double> Nullable

    An additional multiplier to use in calculations

    referenceData
    string Nullable

    Reference data for miscellaneous metadata from updates

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Delete a single exchange rate for a specified currency-code and target currency-code.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    currencyCode
    required
    string Nullable

    Currency code

    toCurrencyCode
    required
    string Nullable

    C

    Responses

    Retrieves a single exchange rate for a specified currency-code and target-currency-code.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    currencyCode
    required
    string Nullable

    Currency code

    toCurrencyCode
    required
    string Nullable

    Target currency code

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "fromCurrencyCode": "string",
    • "toCurrencyCode": "string",
    • "rate": 0,
    • "multiplier": 0,
    • "referenceData": "string",
    • "auditInfo": {
      }
    }

    Discount

    Generates a random code for a coupon.

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    "string"

    Retrieves a list of discounts according to any specified filter criteria and sort options.

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional.

    pageSize
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.

    sortBy
    string Nullable

    The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

    filter
    string Nullable

    A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

    responseGroups
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Creates a discount.

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json

    Properties of the discount to create. Required properties: Content.Name, AmountType, StartDate, and Target.Type.

    id
    integer <int32> Nullable

    Unique identifier of the discount. System-supplied and read-only.

    required
    object (DiscountLocalizedContent)

    Container for the language-specific name of the discount. You will have a container for each supported language (LocaleCode). This enables you to display the discount name in multiple languages yet manage it as a single discount internally.

    scope
    required
    string

    Scope to which the discount applies, valid values are: Order, LineItem

    object (DiscountCondition)

    Specifies constraints that must be satified for a discount to be applied to a target. Constraints are Anded together

    required
    object (DiscountTarget)

    What to discount. Specifies the type of discount (percentage off, monetary amount, or free shipping) and which products, categories, or shipping methods are eligible for the discount. Can also specify the minimum amount that the order must total for the discount to apply.

    currentRedemptionCount
    integer <int32> Nullable

    How many times this discount has been redeemed. System-supplied and read-only.

    amount
    number <double> Nullable 
    Amount of the discount, as a percentage or monetary amount, for example 15% or $15.

    Must be either null or greater than zero.

    amountType
    required
    string

    Type of discount, which can be either a percentage off the price, a specific monetary amount, or free. Possible values: Percentage Amount Free FixedPrice

    status
    string Nullable

    Discount status which can be "Active," "Scheduled," or "Expired." System-supplied and read-only.

    canBeDeleted
    boolean

    Signifies that the discount is not referenced and can be hard deleted

    doesNotApplyToSalePrice
    boolean Nullable

    Determines if the discount should apply to sale price or regular price only. Discounts will apply to sale prices by default. Only applies to LineItem product discounts.

    doesNotApplyToProductsWithSalePrice
    boolean Nullable

    Determines whether or not a discount applies to a items with a sale price. Applicable on order and line item discounts. For line items, when this is true, the discount will be disqualified. For order level discounts, when true, the discount will not be applied to those items have a sale price.

    maximumUsesPerUser
    integer <int32> Nullable

    Maximum number of times a user can redeem this discount. Must be either null or greater than zero.

    maximumDiscountImpactPerOrder
    number <double> Nullable

    Maximum impact this discount can apply on a single order. Must be either null or greater than zero.

    maximumDiscountImpactPerRedemption
    number <double> Nullable

    Maximum impact this discount can apply on a single line item. Must be either null or greater than zero.

    maximumRedemptionsPerOrder
    integer <int32> Nullable

    Maximum number of redemptions allowed per order. If null, defaults to unlimited.

    includedPriceLists
    Array of strings Nullable

    Products receiving a price from a price list specified here or a child of a specified price list can be discounted.

    doesNotApplyToMultiShipToOrders
    boolean Nullable

    Flag to allow or prevent application to multi-ship-to orders, Only applicable to shipping discounts.

    isBxGx
    boolean Nullable

    Readonly property indicating that the condition required purchase is the same as the target items. Used in BxGx and BoGo type discounts.

    canBeStackedUpon
    boolean Nullable

    Indicates whether or not stacking is enabled for this discount

    stackingLayer
    integer <int32> Nullable

    Indicates which stacking layer this discount is a part of

    object (ThresholdMessage)
    preventLineItemShippingDiscounts
    boolean Nullable

    Prevents Line Item Shipping discounts from being applied when a Line Item Product
    discount has been applied

    preventOrderProductDiscounts
    boolean Nullable

    Prevents Order Product discounts from being applied when a Line Item Product
    or Shipping discount has been applied

    preventOrderShippingDiscounts
    boolean Nullable

    Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping
    or Order Product discount has been applied

    hasPurchaseConditions
    boolean

    Indicates if this discount has purchase conditions that must be met before the discount is applied

    purchaseRequirementType
    string Nullable

    The type of purchase requirement for this discount, either purchase conditions and targets which
    Supports BoGo, and BxGx scenarios. Or Target only that only have a target and no purchase conditions

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": 0,
    • "content": {
      },
    • "scope": "string",
    • "conditions": {
      },
    • "target": {
      },
    • "currentRedemptionCount": 0,
    • "amount": 0,
    • "amountType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "doesNotApplyToSalePrice": true,
    • "doesNotApplyToProductsWithSalePrice": true,
    • "maximumUsesPerUser": 0,
    • "maximumDiscountImpactPerOrder": 0,
    • "maximumDiscountImpactPerRedemption": 0,
    • "maximumRedemptionsPerOrder": 0,
    • "includedPriceLists": [
      ],
    • "doesNotApplyToMultiShipToOrders": true,
    • "isBxGx": true,
    • "canBeStackedUpon": true,
    • "stackingLayer": 0,
    • "thresholdMessage": {
      },
    • "preventLineItemShippingDiscounts": true,
    • "preventOrderProductDiscounts": true,
    • "preventOrderShippingDiscounts": true,
    • "hasPurchaseConditions": true,
    • "purchaseRequirementType": "string",
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "content": {
      },
    • "scope": "string",
    • "conditions": {
      },
    • "target": {
      },
    • "currentRedemptionCount": 0,
    • "amount": 0,
    • "amountType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "doesNotApplyToSalePrice": true,
    • "doesNotApplyToProductsWithSalePrice": true,
    • "maximumUsesPerUser": 0,
    • "maximumDiscountImpactPerOrder": 0,
    • "maximumDiscountImpactPerRedemption": 0,
    • "maximumRedemptionsPerOrder": 0,
    • "includedPriceLists": [
      ],
    • "doesNotApplyToMultiShipToOrders": true,
    • "isBxGx": true,
    • "canBeStackedUpon": true,
    • "stackingLayer": 0,
    • "thresholdMessage": {
      },
    • "preventLineItemShippingDiscounts": true,
    • "preventOrderProductDiscounts": true,
    • "preventOrderShippingDiscounts": true,
    • "hasPurchaseConditions": true,
    • "purchaseRequirementType": "string",
    • "auditInfo": {
      }
    }

    Retrieves the details of a single discount.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    discountId
    required
    integer <int32>

    Unique identifier of the discount. System-supplied and read-only.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "content": {
      },
    • "scope": "string",
    • "conditions": {
      },
    • "target": {
      },
    • "currentRedemptionCount": 0,
    • "amount": 0,
    • "amountType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "doesNotApplyToSalePrice": true,
    • "doesNotApplyToProductsWithSalePrice": true,
    • "maximumUsesPerUser": 0,
    • "maximumDiscountImpactPerOrder": 0,
    • "maximumDiscountImpactPerRedemption": 0,
    • "maximumRedemptionsPerOrder": 0,
    • "includedPriceLists": [
      ],
    • "doesNotApplyToMultiShipToOrders": true,
    • "isBxGx": true,
    • "canBeStackedUpon": true,
    • "stackingLayer": 0,
    • "thresholdMessage": {
      },
    • "preventLineItemShippingDiscounts": true,
    • "preventOrderProductDiscounts": true,
    • "preventOrderShippingDiscounts": true,
    • "hasPurchaseConditions": true,
    • "purchaseRequirementType": "string",
    • "auditInfo": {
      }
    }

    Modifies a discount.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    discountId
    required
    integer <int32>

    Unique identifier of the discount. System-supplied and read-only.

    Request Body schema: application/json

    Properties of the discount to update. Required properties: Content.Name, AmountType, StartDate, and Target.Type. Any unspecified properties are set to null and boolean variables are set to false.

    id
    integer <int32> Nullable

    Unique identifier of the discount. System-supplied and read-only.

    required
    object (DiscountLocalizedContent)

    Container for the language-specific name of the discount. You will have a container for each supported language (LocaleCode). This enables you to display the discount name in multiple languages yet manage it as a single discount internally.

    scope
    required
    string

    Scope to which the discount applies, valid values are: Order, LineItem

    object (DiscountCondition)

    Specifies constraints that must be satified for a discount to be applied to a target. Constraints are Anded together

    required
    object (DiscountTarget)

    What to discount. Specifies the type of discount (percentage off, monetary amount, or free shipping) and which products, categories, or shipping methods are eligible for the discount. Can also specify the minimum amount that the order must total for the discount to apply.

    currentRedemptionCount
    integer <int32> Nullable

    How many times this discount has been redeemed. System-supplied and read-only.

    amount
    number <double> Nullable 
    Amount of the discount, as a percentage or monetary amount, for example 15% or $15.

    Must be either null or greater than zero.

    amountType
    required
    string

    Type of discount, which can be either a percentage off the price, a specific monetary amount, or free. Possible values: Percentage Amount Free FixedPrice

    status
    string Nullable

    Discount status which can be "Active," "Scheduled," or "Expired." System-supplied and read-only.

    canBeDeleted
    boolean

    Signifies that the discount is not referenced and can be hard deleted

    doesNotApplyToSalePrice
    boolean Nullable

    Determines if the discount should apply to sale price or regular price only. Discounts will apply to sale prices by default. Only applies to LineItem product discounts.

    doesNotApplyToProductsWithSalePrice
    boolean Nullable

    Determines whether or not a discount applies to a items with a sale price. Applicable on order and line item discounts. For line items, when this is true, the discount will be disqualified. For order level discounts, when true, the discount will not be applied to those items have a sale price.

    maximumUsesPerUser
    integer <int32> Nullable

    Maximum number of times a user can redeem this discount. Must be either null or greater than zero.

    maximumDiscountImpactPerOrder
    number <double> Nullable

    Maximum impact this discount can apply on a single order. Must be either null or greater than zero.

    maximumDiscountImpactPerRedemption
    number <double> Nullable

    Maximum impact this discount can apply on a single line item. Must be either null or greater than zero.

    maximumRedemptionsPerOrder
    integer <int32> Nullable

    Maximum number of redemptions allowed per order. If null, defaults to unlimited.

    includedPriceLists
    Array of strings Nullable

    Products receiving a price from a price list specified here or a child of a specified price list can be discounted.

    doesNotApplyToMultiShipToOrders
    boolean Nullable

    Flag to allow or prevent application to multi-ship-to orders, Only applicable to shipping discounts.

    isBxGx
    boolean Nullable

    Readonly property indicating that the condition required purchase is the same as the target items. Used in BxGx and BoGo type discounts.

    canBeStackedUpon
    boolean Nullable

    Indicates whether or not stacking is enabled for this discount

    stackingLayer
    integer <int32> Nullable

    Indicates which stacking layer this discount is a part of

    object (ThresholdMessage)
    preventLineItemShippingDiscounts
    boolean Nullable

    Prevents Line Item Shipping discounts from being applied when a Line Item Product
    discount has been applied

    preventOrderProductDiscounts
    boolean Nullable

    Prevents Order Product discounts from being applied when a Line Item Product
    or Shipping discount has been applied

    preventOrderShippingDiscounts
    boolean Nullable

    Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping
    or Order Product discount has been applied

    hasPurchaseConditions
    boolean

    Indicates if this discount has purchase conditions that must be met before the discount is applied

    purchaseRequirementType
    string Nullable

    The type of purchase requirement for this discount, either purchase conditions and targets which
    Supports BoGo, and BxGx scenarios. Or Target only that only have a target and no purchase conditions

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": 0,
    • "content": {
      },
    • "scope": "string",
    • "conditions": {
      },
    • "target": {
      },
    • "currentRedemptionCount": 0,
    • "amount": 0,
    • "amountType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "doesNotApplyToSalePrice": true,
    • "doesNotApplyToProductsWithSalePrice": true,
    • "maximumUsesPerUser": 0,
    • "maximumDiscountImpactPerOrder": 0,
    • "maximumDiscountImpactPerRedemption": 0,
    • "maximumRedemptionsPerOrder": 0,
    • "includedPriceLists": [
      ],
    • "doesNotApplyToMultiShipToOrders": true,
    • "isBxGx": true,
    • "canBeStackedUpon": true,
    • "stackingLayer": 0,
    • "thresholdMessage": {
      },
    • "preventLineItemShippingDiscounts": true,
    • "preventOrderProductDiscounts": true,
    • "preventOrderShippingDiscounts": true,
    • "hasPurchaseConditions": true,
    • "purchaseRequirementType": "string",
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "content": {
      },
    • "scope": "string",
    • "conditions": {
      },
    • "target": {
      },
    • "currentRedemptionCount": 0,
    • "amount": 0,
    • "amountType": "string",
    • "status": "string",
    • "canBeDeleted": true,
    • "doesNotApplyToSalePrice": true,
    • "doesNotApplyToProductsWithSalePrice": true,
    • "maximumUsesPerUser": 0,
    • "maximumDiscountImpactPerOrder": 0,
    • "maximumDiscountImpactPerRedemption": 0,
    • "maximumRedemptionsPerOrder": 0,
    • "includedPriceLists": [
      ],
    • "doesNotApplyToMultiShipToOrders": true,
    • "isBxGx": true,
    • "canBeStackedUpon": true,
    • "stackingLayer": 0,
    • "thresholdMessage": {
      },
    • "preventLineItemShippingDiscounts": true,
    • "preventOrderProductDiscounts": true,
    • "preventOrderShippingDiscounts": true,
    • "hasPurchaseConditions": true,
    • "purchaseRequirementType": "string",
    • "auditInfo": {
      }
    }

    Deletes a discount specified by its discount ID.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    discountId
    required
    integer <int32>

    Unique identifier of the discount. System-supplied and read-only.

    Responses

    Retrieves the localized content specified for the specified discount.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    discountId
    required
    integer <int32>

    Unique identifier of the discount. System-supplied and read-only.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "name": "string",
    • "friendlyDescription": "string",
    • "auditInfo": {
      }
    }

    Modifies the localized content for the specified discount. Allows you to rename the discount without modifying any other discount properties.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    discountId
    required
    integer <int32>

    Unique identifier of the discount. System-supplied and read-only.

    Request Body schema: application/json

    New Name and/or LocaleCode. Properties of the content to update. Required property: Name.

    localeCode
    string [ 0 .. 8 ] characters Nullable

    Lanugage used for the discount in the current catalog. Defaults setting for the active catalog.

    name
    required
    string [ 0 .. 200 ] characters

    Name of the discount.

    friendlyDescription
    string Nullable

    Promotional text or HTML that can be utilized as friendly content like "Buy this product now and get X!"

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "localeCode": "string",
    • "name": "string",
    • "friendlyDescription": "string",
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "name": "string",
    • "friendlyDescription": "string",
    • "auditInfo": {
      }
    }

    Retrieves the discount target, that is which products, categories, or shipping methods are eligible for the discount.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    discountId
    required
    integer <int32>

    Unique identifier of the discount. System-supplied and read-only.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "type": "string",
    • "includeAllProducts": true,
    • "includedCategoriesOperator": "string",
    • "categories": [
      ],
    • "excludedCategoriesOperator": "string",
    • "excludedCategories": [
      ],
    • "products": [
      ],
    • "excludedProducts": [
      ],
    • "excludeItemsWithExistingShippingDiscounts": true,
    • "excludeItemsWithExistingProductDiscounts": true,
    • "shippingMethods": [
      ],
    • "shippingZones": [
      ],
    • "maximumQuantityPerRedemption": 0,
    • "appliesToLeastExpensiveProductsFirst": true
    }

    Modifies properties of the discount target, for example, the dollar amount, or precentage off the price.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    discountId
    required
    integer <int32>

    Unique identifier of the discount. System-supplied and read-only.

    Request Body schema: application/json

    Properties of the discount target to modify. Required properties: Target.Type. Any unspecified properties are set to null and boolean variables to false.

    type
    required
    string
    Type of target to which the discount applies. Possible values: <pre>Product</pre> or <pre>Shipping</pre>.

    If this is a 

    Product
    type, you can specify which products or categories that the discount applies to. If this is a 
    Shipping
    type then you must specify which shipping methods apply.

    includeAllProducts
    boolean Nullable

    If yes, the discount applies to all products sold on the storefront.

    includedCategoriesOperator
    string Nullable

    Applies to Included categories When Any, the target product can belong to any specified category. When All, the target product must belong to all specified categories. Defaults to Any

    Array of objects (TargetedCategory) Nullable

    List of categories to discount. When a discount applies to a category, all products in the category are discounted.

    excludedCategoriesOperator
    string Nullable

    Applies to Included categories Defaults to Any

    Array of objects (TargetedCategory) Nullable

    List of categories to exclude from the discount. Useful to exclude specific child categories.

    Array of objects (TargetedProduct) Nullable

    List of products that are eligible for the discount.

    Array of objects (TargetedProduct) Nullable

    List of products that are excluded from the discount.

    excludeItemsWithExistingShippingDiscounts
    boolean Nullable

    Prevents order scoped discounts from layering over items that already have a shipping discount with the same type.

    excludeItemsWithExistingProductDiscounts
    boolean Nullable

    Prevents order scoped discounts from layering over items that already have a product discount with the same type.

    Array of objects (TargetedShippingMethod) Nullable

    Shipping method that is eligible for shipping discounts. This is a shipping method defined in Shipping Settings.

    Array of objects (TargetedShippingZone) Nullable

    Shipping Zones that are applicable for this discount

    maximumQuantityPerRedemption
    integer <int32> Nullable

    When a condition is specified, this property limits the number of items that can be targeted per discount redemption with an order. if multiple redemptions are allowed per order then multiples of this value would be allowed in multiples of the associated condition. If no condition is specified then this value is not used.
    If null and condition exists, then defaults to 1.

    appliesToLeastExpensiveProductsFirst
    boolean Nullable

    Determines which way the discount is optimized. Consumers favor(default - false/null) or tenants favor (when this is set to true) Applies to discounts where target is not a specific product or list of products.
    May also impact behavior of Buy X Get Y so that X is the most expensive items and Y the least expensive.

    Responses

    Request samples

    Content type
    application/json
    {
    • "type": "string",
    • "includeAllProducts": true,
    • "includedCategoriesOperator": "string",
    • "categories": [
      ],
    • "excludedCategoriesOperator": "string",
    • "excludedCategories": [
      ],
    • "products": [
      ],
    • "excludedProducts": [
      ],
    • "excludeItemsWithExistingShippingDiscounts": true,
    • "excludeItemsWithExistingProductDiscounts": true,
    • "shippingMethods": [
      ],
    • "shippingZones": [
      ],
    • "maximumQuantityPerRedemption": 0,
    • "appliesToLeastExpensiveProductsFirst": true
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "type": "string",
    • "includeAllProducts": true,
    • "includedCategoriesOperator": "string",
    • "categories": [
      ],
    • "excludedCategoriesOperator": "string",
    • "excludedCategories": [
      ],
    • "products": [
      ],
    • "excludedProducts": [
      ],
    • "excludeItemsWithExistingShippingDiscounts": true,
    • "excludeItemsWithExistingProductDiscounts": true,
    • "shippingMethods": [
      ],
    • "shippingZones": [
      ],
    • "maximumQuantityPerRedemption": 0,
    • "appliesToLeastExpensiveProductsFirst": true
    }

    DiscountSettings

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    catalogId
    required
    integer <int32>

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "stackingConfiguration": {
      },
    • "usePostDiscountedOrderValue": true
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    catalogId
    required
    integer <int32>
    Request Body schema: application/json
    object (StackingConfiguration)
    usePostDiscountedOrderValue
    boolean Nullable

    Use the pre or post line item discounts order total to evaluate the order minimum constraint

    Responses

    Request samples

    Content type
    application/json
    {
    • "stackingConfiguration": {
      },
    • "usePostDiscountedOrderValue": true
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "stackingConfiguration": {
      },
    • "usePostDiscountedOrderValue": true
    }

    Facet

    Retrieves the details of a Facet Definition

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    facetId
    required
    integer <int32>
    query Parameters
    validate
    boolean Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "facetId": 0,
    • "source": {
      },
    • "facetType": "string",
    • "order": 0,
    • "categoryId": 0,
    • "valueSortType": "string",
    • "overrideFacetId": 0,
    • "isHidden": true,
    • "validity": {
      },
    • "rangeQueries": [
      ],
    • "auditInfo": {
      }
    }

    Modifies a Facet definition

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    facetId
    required
    integer <int32>
    Request Body schema: application/json
    facetId
    integer <int32> Nullable

    The unique identifier for the facet definition

    object (FacetSource)
    facetType
    string Nullable

    The type of facet. Allowable values are: Value, RangeQuery Must be a valid value for DataType defined in FacetTypeConst.

    order
    integer <int32>

    Used to order the display of the facets within a section

    categoryId
    integer <int32>

    The category that the facet is being configured at

    valueSortType
    string Nullable

    Determines how the facet values will be sorted in the store. Must be a valid value for DataType defined in FacetValueSortTypeConst. Allowable values are: CountAscending, CountDescending, ValuesAscending, ValuesDescending, AttributeDefinition, AttributeDefinitionDescending. The default if no value is specified will be CountDescending.

    overrideFacetId
    integer <int32> Nullable

    The ID of a parent category's facet being overriden

    isHidden
    boolean

    Indicates whether the facet is hidden for the given category

    object (FacetValidity)
    Array of objects (FacetRangeQuery) Nullable

    List of ranges if the Facet is of type Range

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "facetId": 0,
    • "source": {
      },
    • "facetType": "string",
    • "order": 0,
    • "categoryId": 0,
    • "valueSortType": "string",
    • "overrideFacetId": 0,
    • "isHidden": true,
    • "validity": {
      },
    • "rangeQueries": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "facetId": 0,
    • "source": {
      },
    • "facetType": "string",
    • "order": 0,
    • "categoryId": 0,
    • "valueSortType": "string",
    • "overrideFacetId": 0,
    • "isHidden": true,
    • "validity": {
      },
    • "rangeQueries": [
      ],
    • "auditInfo": {
      }
    }

    Deletes the Facet definition from the store

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    facetId
    required
    integer <int32>

    Responses

    Adds a new Facet to a category in a catalog.

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    facetId
    integer <int32> Nullable

    The unique identifier for the facet definition

    object (FacetSource)
    facetType
    string Nullable

    The type of facet. Allowable values are: Value, RangeQuery Must be a valid value for DataType defined in FacetTypeConst.

    order
    integer <int32>

    Used to order the display of the facets within a section

    categoryId
    integer <int32>

    The category that the facet is being configured at

    valueSortType
    string Nullable

    Determines how the facet values will be sorted in the store. Must be a valid value for DataType defined in FacetValueSortTypeConst. Allowable values are: CountAscending, CountDescending, ValuesAscending, ValuesDescending, AttributeDefinition, AttributeDefinitionDescending. The default if no value is specified will be CountDescending.

    overrideFacetId
    integer <int32> Nullable

    The ID of a parent category's facet being overriden

    isHidden
    boolean

    Indicates whether the facet is hidden for the given category

    object (FacetValidity)
    Array of objects (FacetRangeQuery) Nullable

    List of ranges if the Facet is of type Range

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "facetId": 0,
    • "source": {
      },
    • "facetType": "string",
    • "order": 0,
    • "categoryId": 0,
    • "valueSortType": "string",
    • "overrideFacetId": 0,
    • "isHidden": true,
    • "validity": {
      },
    • "rangeQueries": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "facetId": 0,
    • "source": {
      },
    • "facetType": "string",
    • "order": 0,
    • "categoryId": 0,
    • "valueSortType": "string",
    • "overrideFacetId": 0,
    • "isHidden": true,
    • "validity": {
      },
    • "rangeQueries": [
      ],
    • "auditInfo": {
      }
    }

    Retrieves a list of configured, and optionally available, Facet Configurations for the specified category

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    categoryId
    required
    integer <int32>
    query Parameters
    includeAvailable
    boolean Nullable
    validate
    boolean Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "configured": [
      ],
    • "available": [
      ]
    }

    LocationInventory

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    locationCode
    required
    string Nullable
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable
    filterFunctions
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    locationCode
    required
    string Nullable
    query Parameters
    performUpserts
    boolean
    Default: false
    Request Body schema: application/json
    Array ()
    locationCode
    string Nullable
    productCode
    string Nullable
    productName
    string Nullable
    stockOnHand
    integer <int32> Nullable
    stockAvailable
    integer <int32> Nullable
    stockOnBackOrder
    integer <int32> Nullable
    baseProductCode
    string Nullable
    sku
    string Nullable
    mfgPartNumber
    string Nullable
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    locationCode
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    productCode
    string Nullable

    The ProductCode of the product to adjust only required when updating via locationInventory resource

    locationCode
    string Nullable

    The Location code of the product to adjust only required when updating via a sub resource of product

    type
    string Nullable

    The type of StockOnHandAdjustment, which can be either Absolute or Delta. Absolute means that Value is the exact number of stock on hand. Delta means that Value is added to or subtracted from the value of StockOnHand.

    value
    integer <int32>

    The absolute or delta value to be applied to StockOnHand.

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    locationCode
    required
    string Nullable
    productCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "locationCode": "string",
    • "productCode": "string",
    • "productName": "string",
    • "stockOnHand": 0,
    • "stockAvailable": 0,
    • "stockOnBackOrder": 0,
    • "baseProductCode": "string",
    • "sku": "string",
    • "mfgPartNumber": "string",
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    locationCode
    required
    string Nullable
    productCode
    required
    string Nullable

    Responses

    MasterCatalog

    <no summary>

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    Get a MasterCatalog

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    masterCatalogId
    required
    integer <int32>

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "name": "string",
    • "productPublishingMode": "string",
    • "enableLiveEdit": true,
    • "isDeleted": true
    }

    Update the publishingMode of a MasterCatalog

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    masterCatalogId
    required
    integer <int32>
    Request Body schema: application/json
    id
    integer <int32>

    MasterCatalogId (readonly)

    name
    string Nullable

    Name of the MasterCatalog (readonly)

    productPublishingMode
    string Nullable

    The product publishing mode of this MasterCatalog

    enableLiveEdit
    boolean Nullable

    If the publishingMode is Pending and LiveEditsEnabled = true, DataViewMode live can be passed in the header and live products can be directly edited.

    isDeleted
    boolean

    Indicates whether the MasterCatalog has been deleted and should no longer be used

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": 0,
    • "name": "string",
    • "productPublishingMode": "string",
    • "enableLiveEdit": true,
    • "isDeleted": true
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "name": "string",
    • "productPublishingMode": "string",
    • "enableLiveEdit": true,
    • "isDeleted": true
    }

    PriceList

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    priceListCode
    required
    string
    priceListSequence
    integer <int32>
    parentPriceListCode
    string Nullable

    Parent PriceList code, Can be null for root level priceLists

    parentPriceListName
    string Nullable

    Parent PriceList name, Can be null for root level priceLists. Read only in contract.

    name
    required
    string

    Name of the priceList. Max length is 100

    description
    string Nullable

    Description of the price list. Max length is 300

    enabled
    boolean Nullable

    Is the price list enabled and valid in the storefront. Default is true.

    filteredInStorefront
    boolean Nullable

    When true, only products with valid price list entries will be visible in the storefront. Default is false

    validForAllSites
    boolean Nullable

    When true, no valid sites need to be specifiied. Price list is considered valid for all sites. Default is true

    validSites
    Array of integers <int32> Nullable

    When ValidForAllSites = false, a list of siteIDs that the price list is valid for should be supplied

    defaultForSites
    Array of integers <int32> Nullable
    indexedSites
    Array of integers <int32> Nullable
    mappedCustomerSegments
    Array of strings Nullable

    List of customer segment code associated with this price list. Used to resolve default price list

    rank
    integer <int32> Nullable

    Used to prioritize price list resolution when more than 1 price list maps

    resolvable
    boolean Nullable

    Determines if this price list can be resolved as the current price list within a session.

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "priceListCode": "string",
    • "priceListSequence": 0,
    • "parentPriceListCode": "string",
    • "parentPriceListName": "string",
    • "name": "string",
    • "description": "string",
    • "enabled": true,
    • "filteredInStorefront": true,
    • "validForAllSites": true,
    • "validSites": [
      ],
    • "defaultForSites": [
      ],
    • "indexedSites": [
      ],
    • "mappedCustomerSegments": [
      ],
    • "rank": 0,
    • "resolvable": true,
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "priceListCode": "string",
    • "priceListSequence": 0,
    • "parentPriceListCode": "string",
    • "parentPriceListName": "string",
    • "name": "string",
    • "description": "string",
    • "enabled": true,
    • "filteredInStorefront": true,
    • "validForAllSites": true,
    • "validSites": [
      ],
    • "defaultForSites": [
      ],
    • "indexedSites": [
      ],
    • "mappedCustomerSegments": [
      ],
    • "rank": 0,
    • "resolvable": true,
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    priceListCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "priceListCode": "string",
    • "priceListSequence": 0,
    • "parentPriceListCode": "string",
    • "parentPriceListName": "string",
    • "name": "string",
    • "description": "string",
    • "enabled": true,
    • "filteredInStorefront": true,
    • "validForAllSites": true,
    • "validSites": [
      ],
    • "defaultForSites": [
      ],
    • "indexedSites": [
      ],
    • "mappedCustomerSegments": [
      ],
    • "rank": 0,
    • "resolvable": true,
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    priceListCode
    required
    string Nullable
    Request Body schema: application/json
    priceListCode
    required
    string
    priceListSequence
    integer <int32>
    parentPriceListCode
    string Nullable

    Parent PriceList code, Can be null for root level priceLists

    parentPriceListName
    string Nullable

    Parent PriceList name, Can be null for root level priceLists. Read only in contract.

    name
    required
    string

    Name of the priceList. Max length is 100

    description
    string Nullable

    Description of the price list. Max length is 300

    enabled
    boolean Nullable

    Is the price list enabled and valid in the storefront. Default is true.

    filteredInStorefront
    boolean Nullable

    When true, only products with valid price list entries will be visible in the storefront. Default is false

    validForAllSites
    boolean Nullable

    When true, no valid sites need to be specifiied. Price list is considered valid for all sites. Default is true

    validSites
    Array of integers <int32> Nullable

    When ValidForAllSites = false, a list of siteIDs that the price list is valid for should be supplied

    defaultForSites
    Array of integers <int32> Nullable
    indexedSites
    Array of integers <int32> Nullable
    mappedCustomerSegments
    Array of strings Nullable

    List of customer segment code associated with this price list. Used to resolve default price list

    rank
    integer <int32> Nullable

    Used to prioritize price list resolution when more than 1 price list maps

    resolvable
    boolean Nullable

    Determines if this price list can be resolved as the current price list within a session.

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "priceListCode": "string",
    • "priceListSequence": 0,
    • "parentPriceListCode": "string",
    • "parentPriceListName": "string",
    • "name": "string",
    • "description": "string",
    • "enabled": true,
    • "filteredInStorefront": true,
    • "validForAllSites": true,
    • "validSites": [
      ],
    • "defaultForSites": [
      ],
    • "indexedSites": [
      ],
    • "mappedCustomerSegments": [
      ],
    • "rank": 0,
    • "resolvable": true,
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "priceListCode": "string",
    • "priceListSequence": 0,
    • "parentPriceListCode": "string",
    • "parentPriceListName": "string",
    • "name": "string",
    • "description": "string",
    • "enabled": true,
    • "filteredInStorefront": true,
    • "validForAllSites": true,
    • "validSites": [
      ],
    • "defaultForSites": [
      ],
    • "indexedSites": [
      ],
    • "mappedCustomerSegments": [
      ],
    • "rank": 0,
    • "resolvable": true,
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    priceListCode
    required
    string Nullable
    query Parameters
    cascadeDeleteEntries
    boolean
    Default: false

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    priceListCode
    required
    string Nullable
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    priceListCode
    required
    string Nullable
    Request Body schema: application/json
    priceListCode
    string Nullable

    External unique identifier of the PriceList. Must be unique an only contain url sanitized characters. Max length is 50

    priceListEntrySequence
    integer <int32>
    productCode
    required
    string
    productName
    string Nullable
    isVariation
    boolean
    Array of objects (ProductOption) Nullable
    currencyCode
    required
    string
    startDate
    string <date-time> Nullable
    endDate
    string <date-time> Nullable
    priceListEntryMode
    string Nullable
    priceListEntryTypeCode
    string Nullable
    discountsRestrictedMode
    string Nullable
    discountsRestricted
    boolean Nullable
    discountsRestrictedStartDate
    string <date-time> Nullable
    discountsRestrictedEndDate
    string <date-time> Nullable
    msrpMode
    string Nullable
    msrp
    number <double> Nullable
    mapMode
    string Nullable
    map
    number <double> Nullable
    mapStartDate
    string <date-time> Nullable
    mapEndDate
    string <date-time> Nullable
    costMode
    string Nullable
    cost
    number <double> Nullable
    Array of objects (PriceListEntryPrice) Nullable
    Array of objects (PriceListEntryExtra) Nullable
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "priceListCode": "string",
    • "priceListEntrySequence": 0,
    • "productCode": "string",
    • "productName": "string",
    • "isVariation": true,
    • "options": [
      ],
    • "currencyCode": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "priceListEntryMode": "string",
    • "priceListEntryTypeCode": "string",
    • "discountsRestrictedMode": "string",
    • "discountsRestricted": true,
    • "discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
    • "discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
    • "msrpMode": "string",
    • "msrp": 0,
    • "mapMode": "string",
    • "map": 0,
    • "mapStartDate": "2019-08-24T14:15:22Z",
    • "mapEndDate": "2019-08-24T14:15:22Z",
    • "costMode": "string",
    • "cost": 0,
    • "priceEntries": [
      ],
    • "extraEntries": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "priceListCode": "string",
    • "priceListEntrySequence": 0,
    • "productCode": "string",
    • "productName": "string",
    • "isVariation": true,
    • "options": [
      ],
    • "currencyCode": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "priceListEntryMode": "string",
    • "priceListEntryTypeCode": "string",
    • "discountsRestrictedMode": "string",
    • "discountsRestricted": true,
    • "discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
    • "discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
    • "msrpMode": "string",
    • "msrp": 0,
    • "mapMode": "string",
    • "map": 0,
    • "mapStartDate": "2019-08-24T14:15:22Z",
    • "mapEndDate": "2019-08-24T14:15:22Z",
    • "costMode": "string",
    • "cost": 0,
    • "priceEntries": [
      ],
    • "extraEntries": [
      ],
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    priceListCode
    required
    string Nullable
    productCode
    required
    string Nullable
    currencyCode
    required
    string Nullable
    query Parameters
    startDate
    string <date-time> Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "priceListCode": "string",
    • "priceListEntrySequence": 0,
    • "productCode": "string",
    • "productName": "string",
    • "isVariation": true,
    • "options": [
      ],
    • "currencyCode": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "priceListEntryMode": "string",
    • "priceListEntryTypeCode": "string",
    • "discountsRestrictedMode": "string",
    • "discountsRestricted": true,
    • "discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
    • "discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
    • "msrpMode": "string",
    • "msrp": 0,
    • "mapMode": "string",
    • "map": 0,
    • "mapStartDate": "2019-08-24T14:15:22Z",
    • "mapEndDate": "2019-08-24T14:15:22Z",
    • "costMode": "string",
    • "cost": 0,
    • "priceEntries": [
      ],
    • "extraEntries": [
      ],
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    priceListCode
    required
    string Nullable
    productCode
    required
    string Nullable
    currencyCode
    required
    string Nullable
    query Parameters
    startDate
    string <date-time> Nullable
    Request Body schema: application/json
    priceListCode
    string Nullable

    External unique identifier of the PriceList. Must be unique an only contain url sanitized characters. Max length is 50

    priceListEntrySequence
    integer <int32>
    productCode
    required
    string
    productName
    string Nullable
    isVariation
    boolean
    Array of objects (ProductOption) Nullable
    currencyCode
    required
    string
    startDate
    string <date-time> Nullable
    endDate
    string <date-time> Nullable
    priceListEntryMode
    string Nullable
    priceListEntryTypeCode
    string Nullable
    discountsRestrictedMode
    string Nullable
    discountsRestricted
    boolean Nullable
    discountsRestrictedStartDate
    string <date-time> Nullable
    discountsRestrictedEndDate
    string <date-time> Nullable
    msrpMode
    string Nullable
    msrp
    number <double> Nullable
    mapMode
    string Nullable
    map
    number <double> Nullable
    mapStartDate
    string <date-time> Nullable
    mapEndDate
    string <date-time> Nullable
    costMode
    string Nullable
    cost
    number <double> Nullable
    Array of objects (PriceListEntryPrice) Nullable
    Array of objects (PriceListEntryExtra) Nullable
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "priceListCode": "string",
    • "priceListEntrySequence": 0,
    • "productCode": "string",
    • "productName": "string",
    • "isVariation": true,
    • "options": [
      ],
    • "currencyCode": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "priceListEntryMode": "string",
    • "priceListEntryTypeCode": "string",
    • "discountsRestrictedMode": "string",
    • "discountsRestricted": true,
    • "discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
    • "discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
    • "msrpMode": "string",
    • "msrp": 0,
    • "mapMode": "string",
    • "map": 0,
    • "mapStartDate": "2019-08-24T14:15:22Z",
    • "mapEndDate": "2019-08-24T14:15:22Z",
    • "costMode": "string",
    • "cost": 0,
    • "priceEntries": [
      ],
    • "extraEntries": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "priceListCode": "string",
    • "priceListEntrySequence": 0,
    • "productCode": "string",
    • "productName": "string",
    • "isVariation": true,
    • "options": [
      ],
    • "currencyCode": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "priceListEntryMode": "string",
    • "priceListEntryTypeCode": "string",
    • "discountsRestrictedMode": "string",
    • "discountsRestricted": true,
    • "discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
    • "discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
    • "msrpMode": "string",
    • "msrp": 0,
    • "mapMode": "string",
    • "map": 0,
    • "mapStartDate": "2019-08-24T14:15:22Z",
    • "mapEndDate": "2019-08-24T14:15:22Z",
    • "costMode": "string",
    • "cost": 0,
    • "priceEntries": [
      ],
    • "extraEntries": [
      ],
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    priceListCode
    required
    string Nullable
    productCode
    required
    string Nullable
    currencyCode
    required
    string Nullable
    query Parameters
    startDate
    string <date-time> Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    publishEvents
    boolean
    Default: true
    invalidateCache
    boolean
    Default: true
    Request Body schema: application/json
    Array ()
    priceListCode
    string Nullable

    External unique identifier of the PriceList. Must be unique an only contain url sanitized characters. Max length is 50

    priceListEntrySequence
    integer <int32>
    productCode
    required
    string
    productName
    string Nullable
    isVariation
    boolean
    Array of objects (ProductOption) Nullable
    currencyCode
    required
    string
    startDate
    string <date-time> Nullable
    endDate
    string <date-time> Nullable
    priceListEntryMode
    string Nullable
    priceListEntryTypeCode
    string Nullable
    discountsRestrictedMode
    string Nullable
    discountsRestricted
    boolean Nullable
    discountsRestrictedStartDate
    string <date-time> Nullable
    discountsRestrictedEndDate
    string <date-time> Nullable
    msrpMode
    string Nullable
    msrp
    number <double> Nullable
    mapMode
    string Nullable
    map
    number <double> Nullable
    mapStartDate
    string <date-time> Nullable
    mapEndDate
    string <date-time> Nullable
    costMode
    string Nullable
    cost
    number <double> Nullable
    Array of objects (PriceListEntryPrice) Nullable
    Array of objects (PriceListEntryExtra) Nullable
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    publishEvents
    boolean
    Default: true
    invalidateCache
    boolean
    Default: true
    Request Body schema: application/json
    Array ()
    priceListCode
    string Nullable

    External unique identifier of the PriceList. Must be unique an only contain url sanitized characters. Max length is 50

    priceListEntrySequence
    integer <int32>
    productCode
    required
    string
    productName
    string Nullable
    isVariation
    boolean
    Array of objects (ProductOption) Nullable
    currencyCode
    required
    string
    startDate
    string <date-time> Nullable
    endDate
    string <date-time> Nullable
    priceListEntryMode
    string Nullable
    priceListEntryTypeCode
    string Nullable
    discountsRestrictedMode
    string Nullable
    discountsRestricted
    boolean Nullable
    discountsRestrictedStartDate
    string <date-time> Nullable
    discountsRestrictedEndDate
    string <date-time> Nullable
    msrpMode
    string Nullable
    msrp
    number <double> Nullable
    mapMode
    string Nullable
    map
    number <double> Nullable
    mapStartDate
    string <date-time> Nullable
    mapEndDate
    string <date-time> Nullable
    costMode
    string Nullable
    cost
    number <double> Nullable
    Array of objects (PriceListEntryPrice) Nullable
    Array of objects (PriceListEntryExtra) Nullable
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    publishEvents
    boolean
    Default: true
    invalidateCache
    boolean
    Default: true
    Request Body schema: application/json
    Array ()
    priceListCode
    string Nullable

    External unique identifier of the PriceList. Must be unique an only contain url sanitized characters. Max length is 50

    priceListEntrySequence
    integer <int32>
    productCode
    required
    string
    productName
    string Nullable
    isVariation
    boolean
    Array of objects (ProductOption) Nullable
    currencyCode
    required
    string
    startDate
    string <date-time> Nullable
    endDate
    string <date-time> Nullable
    priceListEntryMode
    string Nullable
    priceListEntryTypeCode
    string Nullable
    discountsRestrictedMode
    string Nullable
    discountsRestricted
    boolean Nullable
    discountsRestrictedStartDate
    string <date-time> Nullable
    discountsRestrictedEndDate
    string <date-time> Nullable
    msrpMode
    string Nullable
    msrp
    number <double> Nullable
    mapMode
    string Nullable
    map
    number <double> Nullable
    mapStartDate
    string <date-time> Nullable
    mapEndDate
    string <date-time> Nullable
    costMode
    string Nullable
    cost
    number <double> Nullable
    Array of objects (PriceListEntryPrice) Nullable
    Array of objects (PriceListEntryExtra) Nullable
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Product

    Retrieves a list of products according to any specified filter criteria and sort options.

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0.

    pageSize
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the maximum number of entities to return from a single query. The default value is 20 and the maximum value is 200.

    sortBy
    string Nullable

    The element to sort the results by and the order in which the results appear. Either ascending or descending order. For example, to sort the results by “ID” ascending then by “CreateDate” descending, use: id asc,createdate desc.

    responseGroups
    string Nullable

    Used to get more specific information from the request. For example to get discounts applied to a product use the AppliedProducts response group. Available response groups: ApplicableDiscounts, VariationOptions, and BaseProductCode.

    filter
    string Nullable

    A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

    q
    string Nullable
    qLimit
    integer <int32> Nullable
    noCount
    boolean Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Creates a new product. You supply a product name, product code, price and other product characteristics such as its attributes, categories where the product belongs, whether the product has configurable options, stand-alone options, and so on.

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json

    Properties of the new product. Required properties: ProductCode, Content.ProductName, and Price.ListPrice. Mozu.ProductAdmin.Contracts.Product

    productCode
    string Nullable

    Merchant-created code indentifier associated with the product, for example, a SKU or product item number.

    productUsage
    string Nullable

    Indicates the usage type of this product. Must be one of the values in ProductUsageConst.

    fulfillmentTypesSupported
    Array of strings Nullable

    Indicates the fulfillment types the product supports.

    masterCatalogId
    integer <int32> Nullable

    Indentifier of the Master Catalog that this product is a member of. System-supplied and read-only

    productSequence
    integer <int32> Nullable

    System generated monotonically increasing sequence

    productTypeId
    integer <int32> Nullable

    Unique identifier of the productType of the product. Refers to a valid ProductType that was previously created with the ProductType resource.

    isValidForProductType
    boolean Nullable

    Read only flag that indicates if the product meets the product type constraints (All adminRequired attributes have a valid value)

    baseProductCode
    string Nullable

    This is the base product ProductCode of a product that is a variation. It is read-only and only populated for products that are variations of a configurable base product.

    Array of objects (ProductInCatalogInfo) Nullable

    Catalog specifc info for each catalog a product is valid in. There should always be one or more entries here.

    object (ProductLocalizedContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    object (ProductPrice)

    Price of the product and currency used.

    object (ProductPricingBehaviorInfo)

    Pricing behavior associated with the product

    object (ProductLocalizedSEOContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    Array of objects (ProductOption) Nullable

    The Options defined in the product Type that are currently assigned to this product

    Array of objects (ProductExtra) Nullable

    The Extras defined in the product Type that are currently assigned to this product

    Array of objects (ProductProperty) Nullable

    The Properties defined in the product Type that are currently assigned to this product

    isTaxable
    boolean Nullable

    If true, the product is subject to tax.

    object (ProductInventoryInfo)

    Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.

    shippingClassId
    integer <int32> Nullable
    isRecurring
    boolean Nullable

    If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.

    upc
    string Nullable

    UPC code of the product.

    object (ProductSupplierInfo)

    Supplier info for the product

    isPackagedStandAlone
    boolean Nullable

    Does this product need to be packaged on its own

    standAlonePackageType
    string Nullable

    When packaged alone this is the package type

    object (Measurement)
    object (Measurement)
    object (Measurement)
    object (Measurement)
    Array of objects (Discount) Nullable

    Read only. List of discounts that are available for a product.

    isVariation
    boolean

    Read only. If true, this is a product variation of a product with configurable options. System-supplied and read-only.

    variationKey
    string Nullable

    Read only. If IsVariation true, thish provides a unique key to manage the variation of the base product.

    hasConfigurableOptions
    boolean

    Read only. If true, this product has configurable options. The product is not purchasable until the shopper selects options that resolve to a product variation. System-supplied and read-only.

    hasStandAloneOptions
    boolean

    Read only. If true, the product has stand-alone options that a shopper may select. System-supplied and read-only.

    Array of objects (ProductVariationOption) Nullable

    Read only List of variations that exist for a product. This is only populated when IsVariation is true. To get the list of options, the GET request must include the VariationOptions response group.

    object (ProductPublishingInfo)

    Price of the product and currency used.

    Array of objects (BundledProduct) Nullable

    list of other products that are included in a BundleProduct This requires that the ProductUssage be set to Bundle

    Array of objects (ProductImageGroup) Nullable

    List of the image groups this product uses. Image groups are used to map different images to different product options. If the product doesn't have options then all images will be in the default image group.

    object (AuditInfo)
    object (SlicingSettings)

    Container class for Slicing Settings

    Responses

    Request samples

    Content type
    application/json
    {
    • "productCode": "string",
    • "productUsage": "string",
    • "fulfillmentTypesSupported": [
      ],
    • "masterCatalogId": 0,
    • "productSequence": 0,
    • "productTypeId": 0,
    • "isValidForProductType": true,
    • "baseProductCode": "string",
    • "productInCatalogs": [
      ],
    • "content": {
      },
    • "price": {
      },
    • "pricingBehavior": {
      },
    • "seoContent": {
      },
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "isTaxable": true,
    • "inventoryInfo": {
      },
    • "shippingClassId": 0,
    • "isRecurring": true,
    • "upc": "string",
    • "supplierInfo": {
      },
    • "isPackagedStandAlone": true,
    • "standAlonePackageType": "string",
    • "packageHeight": {
      },
    • "packageWidth": {
      },
    • "packageLength": {
      },
    • "packageWeight": {
      },
    • "applicableDiscounts": [
      ],
    • "isVariation": true,
    • "variationKey": "string",
    • "hasConfigurableOptions": true,
    • "hasStandAloneOptions": true,
    • "variationOptions": [
      ],
    • "publishingInfo": {
      },
    • "bundledProducts": [
      ],
    • "productImageGroups": [
      ],
    • "auditInfo": {
      },
    • "slicingSettings": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "productCode": "string",
    • "productUsage": "string",
    • "fulfillmentTypesSupported": [
      ],
    • "masterCatalogId": 0,
    • "productSequence": 0,
    • "productTypeId": 0,
    • "isValidForProductType": true,
    • "baseProductCode": "string",
    • "productInCatalogs": [
      ],
    • "content": {
      },
    • "price": {
      },
    • "pricingBehavior": {
      },
    • "seoContent": {
      },
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "isTaxable": true,
    • "inventoryInfo": {
      },
    • "shippingClassId": 0,
    • "isRecurring": true,
    • "upc": "string",
    • "supplierInfo": {
      },
    • "isPackagedStandAlone": true,
    • "standAlonePackageType": "string",
    • "packageHeight": {
      },
    • "packageWidth": {
      },
    • "packageLength": {
      },
    • "packageWeight": {
      },
    • "applicableDiscounts": [
      ],
    • "isVariation": true,
    • "variationKey": "string",
    • "hasConfigurableOptions": true,
    • "hasStandAloneOptions": true,
    • "variationOptions": [
      ],
    • "publishingInfo": {
      },
    • "bundledProducts": [
      ],
    • "productImageGroups": [
      ],
    • "auditInfo": {
      },
    • "slicingSettings": {
      }
    }

    Retrieves details about a product based on the specified response group. For example, to get the BaseProductCode of a product.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Merchant-created code associated with the product, for example, a SKU. Required.

    query Parameters
    responseGroups
    string Nullable

    Used to get more specific information from the request. For example to get discounts applied to a product use the AppliedProducts response group. Available response groups: ApplicableDiscounts, VariationOptions, and BaseProductCode.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "productCode": "string",
    • "productUsage": "string",
    • "fulfillmentTypesSupported": [
      ],
    • "masterCatalogId": 0,
    • "productSequence": 0,
    • "productTypeId": 0,
    • "isValidForProductType": true,
    • "baseProductCode": "string",
    • "productInCatalogs": [
      ],
    • "content": {
      },
    • "price": {
      },
    • "pricingBehavior": {
      },
    • "seoContent": {
      },
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "isTaxable": true,
    • "inventoryInfo": {
      },
    • "shippingClassId": 0,
    • "isRecurring": true,
    • "upc": "string",
    • "supplierInfo": {
      },
    • "isPackagedStandAlone": true,
    • "standAlonePackageType": "string",
    • "packageHeight": {
      },
    • "packageWidth": {
      },
    • "packageLength": {
      },
    • "packageWeight": {
      },
    • "applicableDiscounts": [
      ],
    • "isVariation": true,
    • "variationKey": "string",
    • "hasConfigurableOptions": true,
    • "hasStandAloneOptions": true,
    • "variationOptions": [
      ],
    • "publishingInfo": {
      },
    • "bundledProducts": [
      ],
    • "productImageGroups": [
      ],
    • "auditInfo": {
      },
    • "slicingSettings": {
      }
    }

    Modifies an existing product.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Merchant-created code associated with the product, for example, a SKU. Required.

    Request Body schema: application/json

    Properties of the product that you want to update. Required properties: ProductCode, Content.ProductName, and Price.ListPrice.

    productCode
    string Nullable

    Merchant-created code indentifier associated with the product, for example, a SKU or product item number.

    productUsage
    string Nullable

    Indicates the usage type of this product. Must be one of the values in ProductUsageConst.

    fulfillmentTypesSupported
    Array of strings Nullable

    Indicates the fulfillment types the product supports.

    masterCatalogId
    integer <int32> Nullable

    Indentifier of the Master Catalog that this product is a member of. System-supplied and read-only

    productSequence
    integer <int32> Nullable

    System generated monotonically increasing sequence

    productTypeId
    integer <int32> Nullable

    Unique identifier of the productType of the product. Refers to a valid ProductType that was previously created with the ProductType resource.

    isValidForProductType
    boolean Nullable

    Read only flag that indicates if the product meets the product type constraints (All adminRequired attributes have a valid value)

    baseProductCode
    string Nullable

    This is the base product ProductCode of a product that is a variation. It is read-only and only populated for products that are variations of a configurable base product.

    Array of objects (ProductInCatalogInfo) Nullable

    Catalog specifc info for each catalog a product is valid in. There should always be one or more entries here.

    object (ProductLocalizedContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    object (ProductPrice)

    Price of the product and currency used.

    object (ProductPricingBehaviorInfo)

    Pricing behavior associated with the product

    object (ProductLocalizedSEOContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    Array of objects (ProductOption) Nullable

    The Options defined in the product Type that are currently assigned to this product

    Array of objects (ProductExtra) Nullable

    The Extras defined in the product Type that are currently assigned to this product

    Array of objects (ProductProperty) Nullable

    The Properties defined in the product Type that are currently assigned to this product

    isTaxable
    boolean Nullable

    If true, the product is subject to tax.

    object (ProductInventoryInfo)

    Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.

    shippingClassId
    integer <int32> Nullable
    isRecurring
    boolean Nullable

    If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.

    upc
    string Nullable

    UPC code of the product.

    object (ProductSupplierInfo)

    Supplier info for the product

    isPackagedStandAlone
    boolean Nullable

    Does this product need to be packaged on its own

    standAlonePackageType
    string Nullable

    When packaged alone this is the package type

    object (Measurement)
    object (Measurement)
    object (Measurement)
    object (Measurement)
    Array of objects (Discount) Nullable

    Read only. List of discounts that are available for a product.

    isVariation
    boolean

    Read only. If true, this is a product variation of a product with configurable options. System-supplied and read-only.

    variationKey
    string Nullable

    Read only. If IsVariation true, thish provides a unique key to manage the variation of the base product.

    hasConfigurableOptions
    boolean

    Read only. If true, this product has configurable options. The product is not purchasable until the shopper selects options that resolve to a product variation. System-supplied and read-only.

    hasStandAloneOptions
    boolean

    Read only. If true, the product has stand-alone options that a shopper may select. System-supplied and read-only.

    Array of objects (ProductVariationOption) Nullable

    Read only List of variations that exist for a product. This is only populated when IsVariation is true. To get the list of options, the GET request must include the VariationOptions response group.

    object (ProductPublishingInfo)

    Price of the product and currency used.

    Array of objects (BundledProduct) Nullable

    list of other products that are included in a BundleProduct This requires that the ProductUssage be set to Bundle

    Array of objects (ProductImageGroup) Nullable

    List of the image groups this product uses. Image groups are used to map different images to different product options. If the product doesn't have options then all images will be in the default image group.

    object (AuditInfo)
    object (SlicingSettings)

    Container class for Slicing Settings

    Responses

    Request samples

    Content type
    application/json
    {
    • "productCode": "string",
    • "productUsage": "string",
    • "fulfillmentTypesSupported": [
      ],
    • "masterCatalogId": 0,
    • "productSequence": 0,
    • "productTypeId": 0,
    • "isValidForProductType": true,
    • "baseProductCode": "string",
    • "productInCatalogs": [
      ],
    • "content": {
      },
    • "price": {
      },
    • "pricingBehavior": {
      },
    • "seoContent": {
      },
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "isTaxable": true,
    • "inventoryInfo": {
      },
    • "shippingClassId": 0,
    • "isRecurring": true,
    • "upc": "string",
    • "supplierInfo": {
      },
    • "isPackagedStandAlone": true,
    • "standAlonePackageType": "string",
    • "packageHeight": {
      },
    • "packageWidth": {
      },
    • "packageLength": {
      },
    • "packageWeight": {
      },
    • "applicableDiscounts": [
      ],
    • "isVariation": true,
    • "variationKey": "string",
    • "hasConfigurableOptions": true,
    • "hasStandAloneOptions": true,
    • "variationOptions": [
      ],
    • "publishingInfo": {
      },
    • "bundledProducts": [
      ],
    • "productImageGroups": [
      ],
    • "auditInfo": {
      },
    • "slicingSettings": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "productCode": "string",
    • "productUsage": "string",
    • "fulfillmentTypesSupported": [
      ],
    • "masterCatalogId": 0,
    • "productSequence": 0,
    • "productTypeId": 0,
    • "isValidForProductType": true,
    • "baseProductCode": "string",
    • "productInCatalogs": [
      ],
    • "content": {
      },
    • "price": {
      },
    • "pricingBehavior": {
      },
    • "seoContent": {
      },
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "isTaxable": true,
    • "inventoryInfo": {
      },
    • "shippingClassId": 0,
    • "isRecurring": true,
    • "upc": "string",
    • "supplierInfo": {
      },
    • "isPackagedStandAlone": true,
    • "standAlonePackageType": "string",
    • "packageHeight": {
      },
    • "packageWidth": {
      },
    • "packageLength": {
      },
    • "packageWeight": {
      },
    • "applicableDiscounts": [
      ],
    • "isVariation": true,
    • "variationKey": "string",
    • "hasConfigurableOptions": true,
    • "hasStandAloneOptions": true,
    • "variationOptions": [
      ],
    • "publishingInfo": {
      },
    • "bundledProducts": [
      ],
    • "productImageGroups": [
      ],
    • "auditInfo": {
      },
    • "slicingSettings": {
      }
    }

    Deletes the product specified by its product code.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Merchant-created code associated with the product, for example, a SKU. Required.

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    catalogId
    required
    integer <int32>
    Request Body schema: application/json
    catalogId
    integer <int32>

    The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to)

    isActive
    boolean Nullable

    If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront.

    isContentOverridden
    boolean Nullable

    If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product.

    object (ProductLocalizedContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    isPriceOverridden
    boolean Nullable

    If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product.

    object (ProductPrice)

    Price of the product and currency used.

    isSeoContentOverridden
    boolean Nullable

    If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product.

    object (ProductLocalizedSEOContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    Array of objects (ProductCategory) Nullable

    Categories to which the product belongs for this catalog.

    object (ProductCategory)

    Categories to which the product belongs.

    dateFirstAvailableInCatalog
    string <date-time> Nullable

    Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.

    object (ActiveDateRange)

    Active Effectivity Dates

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "catalogId": 0,
    • "isActive": true,
    • "isContentOverridden": true,
    • "content": {
      },
    • "isPriceOverridden": true,
    • "price": {
      },
    • "isSeoContentOverridden": true,
    • "seoContent": {
      },
    • "productCategories": [
      ],
    • "primaryProductCategory": {
      },
    • "dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
    • "activeDateRange": {
      },
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "catalogId": 0,
    • "isActive": true,
    • "isContentOverridden": true,
    • "content": {
      },
    • "isPriceOverridden": true,
    • "price": {
      },
    • "isSeoContentOverridden": true,
    • "seoContent": {
      },
    • "productCategories": [
      ],
    • "primaryProductCategory": {
      },
    • "dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
    • "activeDateRange": {
      },
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    catalogId
    required
    integer <int32>

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    catalogId
    required
    integer <int32>

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "catalogId": 0,
    • "isActive": true,
    • "isContentOverridden": true,
    • "content": {
      },
    • "isPriceOverridden": true,
    • "price": {
      },
    • "isSeoContentOverridden": true,
    • "seoContent": {
      },
    • "productCategories": [
      ],
    • "primaryProductCategory": {
      },
    • "dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
    • "activeDateRange": {
      },
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    catalogId
    integer <int32>

    The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to)

    isActive
    boolean Nullable

    If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront.

    isContentOverridden
    boolean Nullable

    If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product.

    object (ProductLocalizedContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    isPriceOverridden
    boolean Nullable

    If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product.

    object (ProductPrice)

    Price of the product and currency used.

    isSeoContentOverridden
    boolean Nullable

    If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product.

    object (ProductLocalizedSEOContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    Array of objects (ProductCategory) Nullable

    Categories to which the product belongs for this catalog.

    object (ProductCategory)

    Categories to which the product belongs.

    dateFirstAvailableInCatalog
    string <date-time> Nullable

    Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.

    object (ActiveDateRange)

    Active Effectivity Dates

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    Request Body schema: application/json
    catalogId
    integer <int32>

    The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to)

    isActive
    boolean Nullable

    If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront.

    isContentOverridden
    boolean Nullable

    If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product.

    object (ProductLocalizedContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    isPriceOverridden
    boolean Nullable

    If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product.

    object (ProductPrice)

    Price of the product and currency used.

    isSeoContentOverridden
    boolean Nullable

    If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product.

    object (ProductLocalizedSEOContent)

    Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

    Array of objects (ProductCategory) Nullable

    Categories to which the product belongs for this catalog.

    object (ProductCategory)

    Categories to which the product belongs.

    dateFirstAvailableInCatalog
    string <date-time> Nullable

    Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.

    object (ActiveDateRange)

    Active Effectivity Dates

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "catalogId": 0,
    • "isActive": true,
    • "isContentOverridden": true,
    • "content": {
      },
    • "isPriceOverridden": true,
    • "price": {
      },
    • "isSeoContentOverridden": true,
    • "seoContent": {
      },
    • "productCategories": [
      ],
    • "primaryProductCategory": {
      },
    • "dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
    • "activeDateRange": {
      },
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "catalogId": 0,
    • "isActive": true,
    • "isContentOverridden": true,
    • "content": {
      },
    • "isPriceOverridden": true,
    • "price": {
      },
    • "isSeoContentOverridden": true,
    • "seoContent": {
      },
    • "productCategories": [
      ],
    • "primaryProductCategory": {
      },
    • "dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
    • "activeDateRange": {
      },
    • "auditInfo": {
      }
    }

    Action that allows productCodes to be Renamed. Changing the resource identifier of a product could cause problems for established products.

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json

    An array specifying the existing productCode and the new productCode it should be renamed to

    Array ()
    existingProductCode
    string Nullable

    The existing ProductCode that should be renamed

    newProductCode
    string Nullable

    The new ProductCode that will be the result of the rename

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieves a paged list of product variations for a specific product according to any specified filter criteria and sort options.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Merchant-supplied code associated with the product, for example, a SKU. Required.

    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional.

    pageSize
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.

    sortBy
    string Nullable

    The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

    filter
    string Nullable

    A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Modifies multiple product variations for an existing product in one operation. Use to set IsActive to true for variations that represent configurable options for sale. Also use to change the price or inventory count of an existing product variation. Read-only options are ignored.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Merchant-supplied code associated with the product, for example, a SKU. Required.

    Request Body schema: application/json

    Properties of the product variations that you are modifying. Required.

    totalCount
    integer <int32>
    Array of objects (ProductVariation) Nullable

    Responses

    Request samples

    Content type
    application/json
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    Retrieves an existing product variation for a specific product and variation key.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Merchant-created code associated with the product, for example, a SKU. Required.

    variationKey
    required
    string Nullable

    Unique identifier for a single product variation. System-supplied and read-only.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "isActive": true,
    • "isOrphan": true,
    • "variationExists": true,
    • "variationkey": "string",
    • "variationProductCode": "string",
    • "deltaPrice": {
      },
    • "localizedDeltaPrice": [
      ],
    • "fixedPrice": {
      },
    • "localizedFixedPrice": [
      ],
    • "deltaWeight": 0,
    • "fixedWeight": 0,
    • "options": [
      ],
    • "upc": "string",
    • "fulfillmentTypesSupported": [
      ],
    • "supplierInfo": {
      }
    }

    Modifies an existing product variation specified by its variation key. Typically used to change the price or inventory count of an existing product variation. Read-only options are ignored.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Merchant-created code associated with the product, for example, a SKU. Required.

    variationKey
    required
    string Nullable

    Unique identifier for a single variation. System-supplied and read-only.

    Request Body schema: application/json

    Properties of the product variation that you are modifying. Required.

    isActive
    boolean Nullable

    If true, the merchant accepts the variation generated from the configurable options as a product offering. If IsActive is false then the product variation is not for sale--either because it was never a product offering or it was permanently dropped. IsActive is not intended for temporary unavailability. Default is false.

    isOrphan
    boolean Nullable

    If true, the variation is no longer possible. The system sets IsOrphan to true when the merchant has changed something to make this variation impossible. For example, if the merchant stopped selling all "small" shirts, all product variations with the "small" option are set to IsOrphan. System-supplied and read-only.

    variationExists
    boolean Nullable

    If true, the product variation exists. When the merchant sets IsActive to true, the system sets VariationExists to true and creates a Variation Key as a unique identifier for this variation. System-supplied and read-only.

    variationkey
    string Nullable

    Unique identifier for a single variation ("small" + "red" + "short-sleeved"). System-supplied and read-only.

    variationProductCode
    string Nullable

    Descriptive code to refer to a single variation. Typically this is a sequence appended to the base ProduceCode. A merchant can create this code to easily recognize a product variation. By default, the system creates this code by appending a number to the base product. After the merchant supplies this code, it becomes read-only.

    object (ProductVariationDeltaPrice)

    How much more a product variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted automatically.

    Array of objects (ProductVariationDeltaPrice) Nullable

    How much more the variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted accordingly. This collection allows for multiple currencies.

    object (ProductVariationFixedPrice)
    Array of objects (ProductVariationFixedPrice) Nullable

    Price of the variation using fixed per currency This collection allows for multiple currencies.

    deltaWeight
    number <double> Nullable

    Weight of the product with this variation.

    fixedWeight
    number <double> Nullable

    Fixed weight of the product with this variation.

    Array of objects (ProductVariationOption) Nullable

    List of values for this product variation: such as "small, "red.. these are read only here as the variationKey defines the values "

    upc
    string Nullable

    Price Lookup Unit code for the product

    fulfillmentTypesSupported
    Array of strings Nullable

    Indicates the fulfillment types the product supports.

    object (ProductSupplierInfo)

    Supplier info for the product

    Responses

    Request samples

    Content type
    application/json
    {
    • "isActive": true,
    • "isOrphan": true,
    • "variationExists": true,
    • "variationkey": "string",
    • "variationProductCode": "string",
    • "deltaPrice": {
      },
    • "localizedDeltaPrice": [
      ],
    • "fixedPrice": {
      },
    • "localizedFixedPrice": [
      ],
    • "deltaWeight": 0,
    • "fixedWeight": 0,
    • "options": [
      ],
    • "upc": "string",
    • "fulfillmentTypesSupported": [
      ],
    • "supplierInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "isActive": true,
    • "isOrphan": true,
    • "variationExists": true,
    • "variationkey": "string",
    • "variationProductCode": "string",
    • "deltaPrice": {
      },
    • "localizedDeltaPrice": [
      ],
    • "fixedPrice": {
      },
    • "localizedFixedPrice": [
      ],
    • "deltaWeight": 0,
    • "fixedWeight": 0,
    • "options": [
      ],
    • "upc": "string",
    • "fulfillmentTypesSupported": [
      ],
    • "supplierInfo": {
      }
    }

    Deletes an existing product variation.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Merchant-created code associated with the product, for example, a SKU. Required.

    variationKey
    required
    string Nullable

    Unique identifier for a single product variation. System-supplied and read-only.

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    currencyCode
    string Nullable

    Which currency is in use.

    value
    number <double> Nullable

    How much more the variation costs above the cost of the base product.

    msrp
    number <double> Nullable

    Manufacturer Suggested Retail Price.

    creditValue
    number <double> Nullable

    Credit amt of the product

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    Request Body schema: application/json
    currencyCode
    string Nullable

    Which currency is in use.

    value
    number <double> Nullable

    How much more the variation costs above the cost of the base product.

    msrp
    number <double> Nullable

    Manufacturer Suggested Retail Price.

    creditValue
    number <double> Nullable

    Credit amt of the product

    Responses

    Request samples

    Content type
    application/json
    {
    • "currencyCode": "string",
    • "value": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "value": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    currencyCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "value": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    currencyCode
    required
    string Nullable
    Request Body schema: application/json
    currencyCode
    string Nullable

    Which currency is in use.

    value
    number <double> Nullable

    How much more the variation costs above the cost of the base product.

    msrp
    number <double> Nullable

    Manufacturer Suggested Retail Price.

    creditValue
    number <double> Nullable

    Credit amt of the product

    Responses

    Request samples

    Content type
    application/json
    {
    • "currencyCode": "string",
    • "value": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "value": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    currencyCode
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    currencyCode
    string Nullable

    Which currency is in use.

    listPrice
    number <double> Nullable

    Variation price for fixed pricing

    salePrice
    number <double> Nullable

    Variation sale price whne fixed pricing

    msrp
    number <double> Nullable

    Manufacturer Suggested Retail Price.

    creditValue
    number <double> Nullable

    Credit amt of the product

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    Request Body schema: application/json
    currencyCode
    string Nullable

    Which currency is in use.

    listPrice
    number <double> Nullable

    Variation price for fixed pricing

    salePrice
    number <double> Nullable

    Variation sale price whne fixed pricing

    msrp
    number <double> Nullable

    Manufacturer Suggested Retail Price.

    creditValue
    number <double> Nullable

    Credit amt of the product

    Responses

    Request samples

    Content type
    application/json
    {
    • "currencyCode": "string",
    • "listPrice": 0,
    • "salePrice": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "listPrice": 0,
    • "salePrice": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    currencyCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "listPrice": 0,
    • "salePrice": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    currencyCode
    required
    string Nullable
    Request Body schema: application/json
    currencyCode
    string Nullable

    Which currency is in use.

    listPrice
    number <double> Nullable

    Variation price for fixed pricing

    salePrice
    number <double> Nullable

    Variation sale price whne fixed pricing

    msrp
    number <double> Nullable

    Manufacturer Suggested Retail Price.

    creditValue
    number <double> Nullable

    Credit amt of the product

    Responses

    Request samples

    Content type
    application/json
    {
    • "currencyCode": "string",
    • "listPrice": 0,
    • "salePrice": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "listPrice": 0,
    • "salePrice": 0,
    • "msrp": 0,
    • "creditValue": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    variationKey
    required
    string Nullable
    currencyCode
    required
    string Nullable

    Responses

    Get extras for the product

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    Add extra

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute.

    isRequired
    boolean Nullable
    isMultiSelect
    boolean Nullable
    Array of objects (ProductExtraValue) Nullable

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isRequired": true,
    • "isMultiSelect": true,
    • "values": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isRequired": true,
    • "isMultiSelect": true,
    • "values": [
      ]
    }

    Get individual extra

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isRequired": true,
    • "isMultiSelect": true,
    • "values": [
      ]
    }

    Update extra

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute.

    isRequired
    boolean Nullable
    isMultiSelect
    boolean Nullable
    Array of objects (ProductExtraValue) Nullable

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isRequired": true,
    • "isMultiSelect": true,
    • "values": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isRequired": true,
    • "isMultiSelect": true,
    • "values": [
      ]
    }

    Delete extra

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    currencyCode
    string Nullable

    Which currency to use.

    deltaPrice
    number <double>

    Amount of money saved when discounts are applied.

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    Request Body schema: application/json
    currencyCode
    string Nullable

    Which currency to use.

    deltaPrice
    number <double>

    Amount of money saved when discounts are applied.

    Responses

    Request samples

    Content type
    application/json
    {
    • "currencyCode": "string",
    • "deltaPrice": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "deltaPrice": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    currencyCode
    required
    string Nullable
    Request Body schema: application/json
    currencyCode
    string Nullable

    Which currency to use.

    deltaPrice
    number <double>

    Amount of money saved when discounts are applied.

    Responses

    Request samples

    Content type
    application/json
    {
    • "currencyCode": "string",
    • "deltaPrice": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "deltaPrice": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    currencyCode
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    currencyCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "currencyCode": "string",
    • "deltaPrice": 0
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    query Parameters
    performUpserts
    boolean
    Default: false
    Request Body schema: application/json
    Array ()
    locationCode
    string Nullable
    productCode
    string Nullable
    productName
    string Nullable
    stockOnHand
    integer <int32> Nullable
    stockAvailable
    integer <int32> Nullable
    stockOnBackOrder
    integer <int32> Nullable
    baseProductCode
    string Nullable
    sku
    string Nullable
    mfgPartNumber
    string Nullable
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    productCode
    string Nullable

    The ProductCode of the product to adjust only required when updating via locationInventory resource

    locationCode
    string Nullable

    The Location code of the product to adjust only required when updating via a sub resource of product

    type
    string Nullable

    The type of StockOnHandAdjustment, which can be either Absolute or Delta. Absolute means that Value is the exact number of stock on hand. Delta means that Value is added to or subtracted from the value of StockOnHand.

    value
    integer <int32>

    The absolute or delta value to be applied to StockOnHand.

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    locationCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "locationCode": "string",
    • "productCode": "string",
    • "productName": "string",
    • "stockOnHand": 0,
    • "stockAvailable": 0,
    • "stockOnBackOrder": 0,
    • "baseProductCode": "string",
    • "sku": "string",
    • "mfgPartNumber": "string",
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    locationCode
    required
    string Nullable

    Responses

    Get options for the product

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    Add option

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute.

    isProductImageGroupSelector
    boolean Nullable

    Defines whether or not this option can be used to segment product images

    Array of objects (ProductOptionValue) Nullable

    List of all the values for this product option.

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isProductImageGroupSelector": true,
    • "values": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isProductImageGroupSelector": true,
    • "values": [
      ]
    }

    Get individual option

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isProductImageGroupSelector": true,
    • "values": [
      ]
    }

    Update option

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute.

    isProductImageGroupSelector
    boolean Nullable

    Defines whether or not this option can be used to segment product images

    Array of objects (ProductOptionValue) Nullable

    List of all the values for this product option.

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isProductImageGroupSelector": true,
    • "values": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isProductImageGroupSelector": true,
    • "values": [
      ]
    }

    Delete option

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable

    Responses

    Get properties for the product

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    Add property

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute.

    Array of objects (ProductPropertyValue) Nullable

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "values": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "values": [
      ]
    }

    Get individual property

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "values": [
      ]
    }

    Update property

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute.

    Array of objects (ProductPropertyValue) Nullable

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "values": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "values": [
      ]
    }

    Delete property

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    Request Body schema: application/json
    localeCode
    string Nullable

    Language used for the string attribute value.

    stringValue
    string Nullable

    Localized Value in the language of the locale code

    Responses

    Request samples

    Content type
    application/json
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    Request Body schema: application/json
    Array ()
    localeCode
    string Nullable

    Language used for the string attribute value.

    stringValue
    string Nullable

    Localized Value in the language of the locale code

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    localeCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    localeCode
    required
    string Nullable
    Request Body schema: application/json
    localeCode
    string Nullable

    Language used for the string attribute value.

    stringValue
    string Nullable

    Localized Value in the language of the locale code

    Responses

    Request samples

    Content type
    application/json
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "localeCode": "string",
    • "stringValue": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productCode
    required
    string Nullable
    attributeFQN
    required
    string Nullable
    value
    required
    string Nullable
    localeCode
    required
    string Nullable

    Responses

    ProductSortDefinition

    Retrieves a list of product sort definitions according to any specified filter criteria and sort options.

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. The default value is 0.

    pageSize
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200.

    sortBy
    string Nullable

    The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order.

    filter
    string Nullable

    A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Adds a new product sort definition

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    useProvidedId
    boolean
    Default: false

    If true, the provided Id value will be used as the ProductSortDefinitionId. If omitted or false, the system will generate a ProductSortDefinitionId

    Request Body schema: application/json

    Properties of the new product sort definition. Required properties of StartDate and Name.

    productSortDefinitionId
    integer <int32> Nullable

    System or user provided ID for the ProductSortDefinition

    categoryId
    integer <int32> Nullable
    name
    required
    string

    Short Name for the sort definition. Required.

    startDate
    required
    string <date-time>

    The Start Date when the sort definition becomes active

    endDate
    string <date-time> Nullable

    Optional end date for a product sort definition

    required
    Array of objects (ProductSortExpression)

    Sort expression to apply Max two expressions

    Array of objects (ProductSortOverride) Nullable

    List of products being positioned

    Array of objects (ProductSortOverride) Nullable

    List of products being positioned

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "productSortDefinitionId": 0,
    • "categoryId": 0,
    • "name": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "sortExpressions": [
      ],
    • "boosted": [
      ],
    • "buried": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "productSortDefinitionId": 0,
    • "categoryId": 0,
    • "name": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "sortExpressions": [
      ],
    • "boosted": [
      ],
    • "buried": [
      ],
    • "auditInfo": {
      }
    }

    Gets a single product sort definition.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productSortDefinitionId
    required
    integer <int32>

    Unique identifier of the product sort definition.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "productSortDefinitionId": 0,
    • "categoryId": 0,
    • "name": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "sortExpressions": [
      ],
    • "boosted": [
      ],
    • "buried": [
      ],
    • "auditInfo": {
      }
    }

    Updates the details of a product sort definition

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productSortDefinitionId
    required
    integer <int32>

    Unique identifier of the product sort definition.

    Request Body schema: application/json

    The details of the product sort definition to update.

    productSortDefinitionId
    integer <int32> Nullable

    System or user provided ID for the ProductSortDefinition

    categoryId
    integer <int32> Nullable
    name
    required
    string

    Short Name for the sort definition. Required.

    startDate
    required
    string <date-time>

    The Start Date when the sort definition becomes active

    endDate
    string <date-time> Nullable

    Optional end date for a product sort definition

    required
    Array of objects (ProductSortExpression)

    Sort expression to apply Max two expressions

    Array of objects (ProductSortOverride) Nullable

    List of products being positioned

    Array of objects (ProductSortOverride) Nullable

    List of products being positioned

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "productSortDefinitionId": 0,
    • "categoryId": 0,
    • "name": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "sortExpressions": [
      ],
    • "boosted": [
      ],
    • "buried": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "productSortDefinitionId": 0,
    • "categoryId": 0,
    • "name": "string",
    • "startDate": "2019-08-24T14:15:22Z",
    • "endDate": "2019-08-24T14:15:22Z",
    • "sortExpressions": [
      ],
    • "boosted": [
      ],
    • "buried": [
      ],
    • "auditInfo": {
      }
    }

    Deletes the product sort definition specified by its ProductSortDefinitionID.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productSortDefinitionId
    required
    integer <int32>

    Unique identifier of the product sort definition.

    Responses

    ProductType

    Retrieves a list of product types according to any specified filter criteria and sort options.

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0.

    pageSize
    integer <int32> Nullable
    Default: 0

    Used to page results from a query. Indicates the maximum number of entities to return from a single query. The default value is 20 and the maximum value is 200.

    sortBy
    string Nullable

    The element to sort the results by and the order in which the results appear. Either ascending or descending order. For example, to sort the results by “ID” ascending then by “CreateDate” descending, use: id asc,createdate desc.

    filter
    string Nullable

    A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

    responseGroups
    string Nullable

    Used to get more specific information from the request. For example to get discounts applied to a product use the AppliedProducts response group. Available response groups: ApplicableDiscounts, VariationOptions, and BaseProductCode.

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Add or create product type

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    id
    integer <int32> Nullable

    Unique identifier of the ProductType. System-supplied and read-only.

    name
    string Nullable

    Name of the productType

    masterCatalogId
    integer <int32> Nullable

    Indentifier of the Master Catalog that this ProductType is a member of. System-supplied and read-only.

    isBaseProductType
    boolean

    System supplied and read only. There is only one BaseProductType per MasterCatalog.

    productCount
    integer <int32> Nullable

    Indicates the number of products currently using this Product Type. System-supplied and read-only.

    productUsages
    Array of strings Nullable

    List of ProductUsages supported by the ProductType.

    goodsType
    string Nullable

    The TYpe of Goods of this product

    Array of objects (AttributeInProductType) Nullable

    Collection of the Attributes that are Options in this productType

    Array of objects (AttributeInProductType) Nullable

    Collection of the Attributes that are Extras in this productType

    Array of objects (AttributeInProductType) Nullable

    Collection of the Attributes that are Properties in this productType

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": 0,
    • "name": "string",
    • "masterCatalogId": 0,
    • "isBaseProductType": true,
    • "productCount": 0,
    • "productUsages": [
      ],
    • "goodsType": "string",
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "name": "string",
    • "masterCatalogId": 0,
    • "isBaseProductType": true,
    • "productCount": 0,
    • "productUsages": [
      ],
    • "goodsType": "string",
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "auditInfo": {
      }
    }

    Get product type by Id

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "name": "string",
    • "masterCatalogId": 0,
    • "isBaseProductType": true,
    • "productCount": 0,
    • "productUsages": [
      ],
    • "goodsType": "string",
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "auditInfo": {
      }
    }

    Update product type

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    Request Body schema: application/json
    id
    integer <int32> Nullable

    Unique identifier of the ProductType. System-supplied and read-only.

    name
    string Nullable

    Name of the productType

    masterCatalogId
    integer <int32> Nullable

    Indentifier of the Master Catalog that this ProductType is a member of. System-supplied and read-only.

    isBaseProductType
    boolean

    System supplied and read only. There is only one BaseProductType per MasterCatalog.

    productCount
    integer <int32> Nullable

    Indicates the number of products currently using this Product Type. System-supplied and read-only.

    productUsages
    Array of strings Nullable

    List of ProductUsages supported by the ProductType.

    goodsType
    string Nullable

    The TYpe of Goods of this product

    Array of objects (AttributeInProductType) Nullable

    Collection of the Attributes that are Options in this productType

    Array of objects (AttributeInProductType) Nullable

    Collection of the Attributes that are Extras in this productType

    Array of objects (AttributeInProductType) Nullable

    Collection of the Attributes that are Properties in this productType

    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": 0,
    • "name": "string",
    • "masterCatalogId": 0,
    • "isBaseProductType": true,
    • "productCount": 0,
    • "productUsages": [
      ],
    • "goodsType": "string",
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "id": 0,
    • "name": "string",
    • "masterCatalogId": 0,
    • "isBaseProductType": true,
    • "productCount": 0,
    • "productUsages": [
      ],
    • "goodsType": "string",
    • "options": [
      ],
    • "extras": [
      ],
    • "properties": [
      ],
    • "auditInfo": {
      }
    }

    Delete product type

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    query Parameters
    productCode
    string Nullable
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable
    Request Body schema: application/json
    Array ()
    attributeFQN
    string Nullable

    Unique identifier of the Attribute.

    isProductImageGroupSelector
    boolean Nullable

    Defines whether or not this option can be used to segment product images

    Array of objects (ProductOptionValue) Nullable

    List of all the values for this product option.

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    Get extras

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    Add extra

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

    isInheritedFromBaseType
    boolean Nullable

    If True, the attribute is part of the base product type and can only have order modified.

    order
    integer <int32> Nullable

    Used to order the display of the attributes within a section

    isRequiredByAdmin
    boolean Nullable

    If True, the admin must include this attribute in products of this productType

    isHiddenProperty
    boolean Nullable

    If True, the property is hidden in the storefront. This field only applies to properties.

    isAdminOnlyProperty
    boolean Nullable

    If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.

    isProductDetailsOnlyProperty
    boolean Nullable

    If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

    isMultiValueProperty
    boolean Nullable

    If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

    object (AttributeInProductTypeDisplayInfo)
    Array of objects (AttributeVocabularyValueInProductType) Nullable

    The collection of vocabulary values included in this product type.

    object (Attribute)

    Attribute

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Get extra

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    attributeFQN
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Update extra

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

    isInheritedFromBaseType
    boolean Nullable

    If True, the attribute is part of the base product type and can only have order modified.

    order
    integer <int32> Nullable

    Used to order the display of the attributes within a section

    isRequiredByAdmin
    boolean Nullable

    If True, the admin must include this attribute in products of this productType

    isHiddenProperty
    boolean Nullable

    If True, the property is hidden in the storefront. This field only applies to properties.

    isAdminOnlyProperty
    boolean Nullable

    If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.

    isProductDetailsOnlyProperty
    boolean Nullable

    If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

    isMultiValueProperty
    boolean Nullable

    If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

    object (AttributeInProductTypeDisplayInfo)
    Array of objects (AttributeVocabularyValueInProductType) Nullable

    The collection of vocabulary values included in this product type.

    object (Attribute)

    Attribute

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Delete extra

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    attributeFQN
    required
    string Nullable

    Responses

    Get options for the product type

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    Add option

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

    isInheritedFromBaseType
    boolean Nullable

    If True, the attribute is part of the base product type and can only have order modified.

    order
    integer <int32> Nullable

    Used to order the display of the attributes within a section

    isRequiredByAdmin
    boolean Nullable

    If True, the admin must include this attribute in products of this productType

    isHiddenProperty
    boolean Nullable

    If True, the property is hidden in the storefront. This field only applies to properties.

    isAdminOnlyProperty
    boolean Nullable

    If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.

    isProductDetailsOnlyProperty
    boolean Nullable

    If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

    isMultiValueProperty
    boolean Nullable

    If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

    object (AttributeInProductTypeDisplayInfo)
    Array of objects (AttributeVocabularyValueInProductType) Nullable

    The collection of vocabulary values included in this product type.

    object (Attribute)

    Attribute

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Get individual option

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    attributeFQN
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Update option

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

    isInheritedFromBaseType
    boolean Nullable

    If True, the attribute is part of the base product type and can only have order modified.

    order
    integer <int32> Nullable

    Used to order the display of the attributes within a section

    isRequiredByAdmin
    boolean Nullable

    If True, the admin must include this attribute in products of this productType

    isHiddenProperty
    boolean Nullable

    If True, the property is hidden in the storefront. This field only applies to properties.

    isAdminOnlyProperty
    boolean Nullable

    If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.

    isProductDetailsOnlyProperty
    boolean Nullable

    If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

    isMultiValueProperty
    boolean Nullable

    If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

    object (AttributeInProductTypeDisplayInfo)
    Array of objects (AttributeVocabularyValueInProductType) Nullable

    The collection of vocabulary values included in this product type.

    object (Attribute)

    Attribute

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Delete option

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    attributeFQN
    required
    string Nullable

    Responses

    Get properties

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    [
    • {
      }
    ]

    Add or create property

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

    isInheritedFromBaseType
    boolean Nullable

    If True, the attribute is part of the base product type and can only have order modified.

    order
    integer <int32> Nullable

    Used to order the display of the attributes within a section

    isRequiredByAdmin
    boolean Nullable

    If True, the admin must include this attribute in products of this productType

    isHiddenProperty
    boolean Nullable

    If True, the property is hidden in the storefront. This field only applies to properties.

    isAdminOnlyProperty
    boolean Nullable

    If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.

    isProductDetailsOnlyProperty
    boolean Nullable

    If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

    isMultiValueProperty
    boolean Nullable

    If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

    object (AttributeInProductTypeDisplayInfo)
    Array of objects (AttributeVocabularyValueInProductType) Nullable

    The collection of vocabulary values included in this product type.

    object (Attribute)

    Attribute

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Get property

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    attributeFQN
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Update property

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    attributeFQN
    required
    string Nullable
    Request Body schema: application/json
    attributeFQN
    string Nullable

    Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

    isInheritedFromBaseType
    boolean Nullable

    If True, the attribute is part of the base product type and can only have order modified.

    order
    integer <int32> Nullable

    Used to order the display of the attributes within a section

    isRequiredByAdmin
    boolean Nullable

    If True, the admin must include this attribute in products of this productType

    isHiddenProperty
    boolean Nullable

    If True, the property is hidden in the storefront. This field only applies to properties.

    isAdminOnlyProperty
    boolean Nullable

    If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.

    isProductDetailsOnlyProperty
    boolean Nullable

    If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

    isMultiValueProperty
    boolean Nullable

    If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

    object (AttributeInProductTypeDisplayInfo)
    Array of objects (AttributeVocabularyValueInProductType) Nullable

    The collection of vocabulary values included in this product type.

    object (Attribute)

    Attribute

    Responses

    Request samples

    Content type
    application/json
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "attributeFQN": "string",
    • "isInheritedFromBaseType": true,
    • "order": 0,
    • "isRequiredByAdmin": true,
    • "isHiddenProperty": true,
    • "isAdminOnlyProperty": true,
    • "isProductDetailsOnlyProperty": true,
    • "isMultiValueProperty": true,
    • "displayInfo": {
      },
    • "vocabularyValues": [
      ],
    • "attributeDetail": {
      }
    }

    Delete property

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    productTypeId
    required
    integer <int32>
    attributeFQN
    required
    string Nullable

    Responses

    Publishing

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    allPending
    boolean Nullable

    True = scope to all pending products

    productCodes
    Array of strings Nullable

    List of specific productCodes to scope publish operation against

    publishSetCode
    string Nullable

    The Publish Set to publish

    Responses

    Request samples

    Content type
    application/json
    {
    • "allPending": true,
    • "productCodes": [
      ],
    • "publishSetCode": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    allPending
    boolean Nullable

    True = scope to all pending products

    productCodes
    Array of strings Nullable

    List of specific productCodes to scope publish operation against

    publishSetCode
    string Nullable

    The Publish Set to publish

    Responses

    Request samples

    Content type
    application/json
    {
    • "allPending": true,
    • "productCodes": [
      ],
    • "publishSetCode": "string"
    }

    Retrieves a list of PublishSets including the product counts.

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    code
    string Nullable

    The PublishSet unique identifier

    productCount
    integer <int32>

    Number of product drafts that are included in the publish set

    productCodes
    Array of strings Nullable

    List of specific product codes that are included in the publish set

    Responses

    Request samples

    Content type
    application/json
    {
    • "code": "string",
    • "productCount": 0,
    • "productCodes": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "code": "string",
    • "productCount": 0,
    • "productCodes": [
      ]
    }

    Retrieves the details of a single PublishSet.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    publishSetCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "code": "string",
    • "productCount": 0,
    • "productCodes": [
      ]
    }

    Removes all details about a PublishSet from the product service. If the discardDrafts param is true, it also deletes the product drafts.

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    publishSetCode
    required
    string Nullable

    The code of the PublishSet to delete

    query Parameters
    discardDrafts
    boolean Nullable
    Default: false

    Whether to also discard the drafts for this publish set.

    Responses

    Search

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    localeCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "tenantId": 0,
    • "siteId": 0,
    • "localeCode": "string",
    • "synonymDefinitions": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    localeCode
    required
    string Nullable
    Request Body schema: application/json
    tenantId
    integer <int32>

    Read-only TenantId

    siteId
    integer <int32>

    Read-only Site Id

    localeCode
    string Nullable

    The locale code to which this definition applies

    Array of objects (SynonymDefinition) Nullable

    List of mappings for this definition

    Responses

    Request samples

    Content type
    application/json
    {
    • "tenantId": 0,
    • "siteId": 0,
    • "localeCode": "string",
    • "synonymDefinitions": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "tenantId": 0,
    • "siteId": 0,
    • "localeCode": "string",
    • "synonymDefinitions": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    languageCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "tenantId": 0,
    • "siteId": 0,
    • "localeCode": "string",
    • "synonymDefinitions": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    synonymId
    integer <int32> Nullable

    The unique identifier for the synonym definition

    key
    string Nullable

    If key is defined then map is directed

    synonyms
    Array of strings Nullable

    List of synonyms. If no key is defined the matches are bidirectional

    Responses

    Request samples

    Content type
    application/json
    {
    • "synonymId": 0,
    • "key": "string",
    • "synonyms": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "synonymId": 0,
    • "key": "string",
    • "synonyms": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    synonymId
    required
    integer <int32>

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "synonymId": 0,
    • "key": "string",
    • "synonyms": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    synonymId
    required
    integer <int32>
    Request Body schema: application/json
    synonymId
    integer <int32> Nullable

    The unique identifier for the synonym definition

    key
    string Nullable

    If key is defined then map is directed

    synonyms
    Array of strings Nullable

    List of synonyms. If no key is defined the matches are bidirectional

    Responses

    Request samples

    Content type
    application/json
    {
    • "synonymId": 0,
    • "key": "string",
    • "synonyms": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "synonymId": 0,
    • "key": "string",
    • "synonyms": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    synonymId
    required
    integer <int32>

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    startIndex
    integer <int32> Nullable
    Default: 0
    pageSize
    integer <int32> Nullable
    Default: 0
    sortBy
    string Nullable
    filter
    string Nullable
    responseGroups
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "startIndex": 0,
    • "pageSize": 0,
    • "pageCount": 0,
    • "totalCount": 0,
    • "items": [
      ]
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    siteId
    integer <int32>
    searchTuningRuleCode
    string Nullable
    searchTuningRuleName
    string Nullable
    searchTuningRuleDescription
    string Nullable
    keywords
    Array of strings Nullable
    Array of objects (SearchTuningRuleFilter) Nullable
    active
    boolean
    isDefault
    boolean
    activeStartDate
    string <date-time> Nullable
    activeEndDate
    string <date-time> Nullable
    boostedProductCodes
    Array of strings Nullable
    blockedProductCodes
    Array of strings Nullable
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "siteId": 0,
    • "searchTuningRuleCode": "string",
    • "searchTuningRuleName": "string",
    • "searchTuningRuleDescription": "string",
    • "keywords": [
      ],
    • "filters": [
      ],
    • "active": true,
    • "isDefault": true,
    • "activeStartDate": "2019-08-24T14:15:22Z",
    • "activeEndDate": "2019-08-24T14:15:22Z",
    • "boostedProductCodes": [
      ],
    • "blockedProductCodes": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "siteId": 0,
    • "searchTuningRuleCode": "string",
    • "searchTuningRuleName": "string",
    • "searchTuningRuleDescription": "string",
    • "keywords": [
      ],
    • "filters": [
      ],
    • "active": true,
    • "isDefault": true,
    • "activeStartDate": "2019-08-24T14:15:22Z",
    • "activeEndDate": "2019-08-24T14:15:22Z",
    • "boostedProductCodes": [
      ],
    • "blockedProductCodes": [
      ],
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    searchTuningRuleCode
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "siteId": 0,
    • "searchTuningRuleCode": "string",
    • "searchTuningRuleName": "string",
    • "searchTuningRuleDescription": "string",
    • "keywords": [
      ],
    • "filters": [
      ],
    • "active": true,
    • "isDefault": true,
    • "activeStartDate": "2019-08-24T14:15:22Z",
    • "activeEndDate": "2019-08-24T14:15:22Z",
    • "boostedProductCodes": [
      ],
    • "blockedProductCodes": [
      ],
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    searchTuningRuleCode
    required
    string Nullable
    Request Body schema: application/json
    siteId
    integer <int32>
    searchTuningRuleCode
    string Nullable
    searchTuningRuleName
    string Nullable
    searchTuningRuleDescription
    string Nullable
    keywords
    Array of strings Nullable
    Array of objects (SearchTuningRuleFilter) Nullable
    active
    boolean
    isDefault
    boolean
    activeStartDate
    string <date-time> Nullable
    activeEndDate
    string <date-time> Nullable
    boostedProductCodes
    Array of strings Nullable
    blockedProductCodes
    Array of strings Nullable
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "siteId": 0,
    • "searchTuningRuleCode": "string",
    • "searchTuningRuleName": "string",
    • "searchTuningRuleDescription": "string",
    • "keywords": [
      ],
    • "filters": [
      ],
    • "active": true,
    • "isDefault": true,
    • "activeStartDate": "2019-08-24T14:15:22Z",
    • "activeEndDate": "2019-08-24T14:15:22Z",
    • "boostedProductCodes": [
      ],
    • "blockedProductCodes": [
      ],
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "siteId": 0,
    • "searchTuningRuleCode": "string",
    • "searchTuningRuleName": "string",
    • "searchTuningRuleDescription": "string",
    • "keywords": [
      ],
    • "filters": [
      ],
    • "active": true,
    • "isDefault": true,
    • "activeStartDate": "2019-08-24T14:15:22Z",
    • "activeEndDate": "2019-08-24T14:15:22Z",
    • "boostedProductCodes": [
      ],
    • "blockedProductCodes": [
      ],
    • "auditInfo": {
      }
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    searchTuningRuleCode
    required
    string Nullable

    Responses

    <no summary>

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "sortFields": [
      ],
    • "inclusionExclusionType": "string"
    }

    <no summary>

    Authorizations:
    bearerAuthclientOauth2
    Request Body schema: application/json
    sortFields
    Array of strings Nullable
    inclusionExclusionType
    string Nullable

    Responses

    Request samples

    Content type
    application/json
    {
    • "sortFields": [
      ],
    • "inclusionExclusionType": "string"
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "sortFields": [
      ],
    • "inclusionExclusionType": "string"
    }

    Get CategorySuggestSettings for a specific SearchSettings

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "fieldWeights": [
      ],
    • "personalizationExperience": "string",
    • "personalizationFactor": 0,
    • "returnFields": [
      ]
    }

    Adds or Updates (Upsert) the CategorySuggestSettings for a specific SearchSetting

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable
    Request Body schema: application/json
    Array of objects (FieldWeight) Nullable
    personalizationExperience
    string Nullable
    personalizationFactor
    number <double> Nullable
    returnFields
    Array of strings Nullable

    Responses

    Request samples

    Content type
    application/json
    {
    • "fieldWeights": [
      ],
    • "personalizationExperience": "string",
    • "personalizationFactor": 0,
    • "returnFields": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "fieldWeights": [
      ],
    • "personalizationExperience": "string",
    • "personalizationFactor": 0,
    • "returnFields": [
      ]
    }

    Deletes the CategorySuggestSettings for a specific SearchSetting

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses

    Get ListingSettings for a specific SearchSettings

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "customBoosts": [
      ],
    • "fieldValueBoost": {
      },
    • "personalizationExperience": "string",
    • "personalizationFactor": 0
    }

    Adds or Updates (Upsert) the ListingSettings for a specific SearchSetting

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable
    Request Body schema: application/json
    customBoosts
    Array of strings Nullable
    object (FieldValueBoost)
    personalizationExperience
    string Nullable
    personalizationFactor
    number <double> Nullable

    Responses

    Request samples

    Content type
    application/json
    {
    • "customBoosts": [
      ],
    • "fieldValueBoost": {
      },
    • "personalizationExperience": "string",
    • "personalizationFactor": 0
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "customBoosts": [
      ],
    • "fieldValueBoost": {
      },
    • "personalizationExperience": "string",
    • "personalizationFactor": 0
    }

    Deletes the ListingSettings for a specific SearchSetting

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses

    Get ProductSuggestSettings for a specific SearchSettings

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "fieldWeights": [
      ],
    • "personalizationExperience": "string",
    • "personalizationFactor": 0,
    • "returnFields": [
      ]
    }

    Adds or Updates (Upsert) the ProductSuggestSettings for a specific SearchSetting

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable
    Request Body schema: application/json
    customBoosts
    Array of strings Nullable
    object (FieldValueBoost)
    searchChildProductsByDefault
    boolean
    Array of objects (FieldWeight) Nullable
    personalizationExperience
    string Nullable
    personalizationFactor
    number <double> Nullable
    returnFields
    Array of strings Nullable

    Responses

    Request samples

    Content type
    application/json
    {
    • "customBoosts": [
      ],
    • "fieldValueBoost": {
      },
    • "searchChildProductsByDefault": true,
    • "fieldWeights": [
      ],
    • "personalizationExperience": "string",
    • "personalizationFactor": 0,
    • "returnFields": [
      ]
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "customBoosts": [
      ],
    • "fieldValueBoost": {
      },
    • "searchChildProductsByDefault": true,
    • "fieldWeights": [
      ],
    • "personalizationExperience": "string",
    • "personalizationFactor": 0,
    • "returnFields": [
      ]
    }

    Deletes the ProductSuggestSettings for a specific SearchSetting

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses

    Get site search settings

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "totalCount": 0,
    • "items": [
      ]
    }

    Adds or Updates (Upsert) the Search Settings for a specific site

    Authorizations:
    bearerAuthclientOauth2
    query Parameters
    fromSystemDefault
    boolean
    Default: false
    name
    string Nullable
    makeDefault
    boolean Nullable
    Default: false
    Request Body schema: application/json
    settingsName
    string Nullable
    isDefault
    boolean
    object (SiteSearchSettings)
    object (ProductSuggestSettings)
    object (SuggestSettings)
    object (ListingSettings)
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "settingsName": "string",
    • "isDefault": true,
    • "siteSearchSettings": {
      },
    • "productSuggestSettings": {
      },
    • "categorySuggestSettings": {
      },
    • "listingSettings": {
      },
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "settingsName": "string",
    • "isDefault": true,
    • "siteSearchSettings": {
      },
    • "productSuggestSettings": {
      },
    • "categorySuggestSettings": {
      },
    • "listingSettings": {
      },
    • "auditInfo": {
      }
    }

    Get site search settings

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "settingsName": "string",
    • "isDefault": true,
    • "siteSearchSettings": {
      },
    • "productSuggestSettings": {
      },
    • "categorySuggestSettings": {
      },
    • "listingSettings": {
      },
    • "auditInfo": {
      }
    }

    Adds or Updates (Upsert) the Search Settings for a specific site

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable
    Request Body schema: application/json
    settingsName
    string Nullable
    isDefault
    boolean
    object (SiteSearchSettings)
    object (ProductSuggestSettings)
    object (SuggestSettings)
    object (ListingSettings)
    object (AuditInfo)

    Responses

    Request samples

    Content type
    application/json
    {
    • "settingsName": "string",
    • "isDefault": true,
    • "siteSearchSettings": {
      },
    • "productSuggestSettings": {
      },
    • "categorySuggestSettings": {
      },
    • "listingSettings": {
      },
    • "auditInfo": {
      }
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "settingsName": "string",
    • "isDefault": true,
    • "siteSearchSettings": {
      },
    • "productSuggestSettings": {
      },
    • "categorySuggestSettings": {
      },
    • "listingSettings": {
      },
    • "auditInfo": {
      }
    }

    Adds or Updates (Upsert) the Search Settings for a specific site

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "settingsName": "string",
    • "isDefault": true,
    • "siteSearchSettings": {
      },
    • "productSuggestSettings": {
      },
    • "categorySuggestSettings": {
      },
    • "listingSettings": {
      },
    • "auditInfo": {
      }
    }

    Get the System Default search settings

    Authorizations:
    bearerAuthclientOauth2

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "settingsName": "string",
    • "isDefault": true,
    • "siteSearchSettings": {
      },
    • "productSuggestSettings": {
      },
    • "categorySuggestSettings": {
      },
    • "listingSettings": {
      },
    • "auditInfo": {
      }
    }

    Get SiteSearchSettings for a specific SearchSettings

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "fieldWeights": [
      ],
    • "customBoosts": [
      ],
    • "fieldValueBoost": {
      },
    • "minimumMatchPercents": [
      ],
    • "phraseSlop": 0,
    • "personalizationExperience": "string",
    • "personalizationFactor": 0,
    • "searchChildProductsByDefault": true
    }

    Adds or Updates (Upsert) the SiteSearchSettings for a specific SearchSetting

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable
    Request Body schema: application/json
    Array of objects (SiteSearchFieldWeight) Nullable
    customBoosts
    Array of strings Nullable
    object (FieldValueBoost)
    minimumMatchPercents
    Array of integers <int32> Nullable
    phraseSlop
    integer <int32>
    personalizationExperience
    string Nullable
    personalizationFactor
    number <double> Nullable
    searchChildProductsByDefault
    boolean

    Responses

    Request samples

    Content type
    application/json
    {
    • "fieldWeights": [
      ],
    • "customBoosts": [
      ],
    • "fieldValueBoost": {
      },
    • "minimumMatchPercents": [
      ],
    • "phraseSlop": 0,
    • "personalizationExperience": "string",
    • "personalizationFactor": 0,
    • "searchChildProductsByDefault": true
    }

    Response samples

    Content type
    application/json
    application/json
    text/json
    text/plain
    {
    • "fieldWeights": [
      ],
    • "customBoosts": [
      ],
    • "fieldValueBoost": {
      },
    • "minimumMatchPercents": [
      ],
    • "phraseSlop": 0,
    • "personalizationExperience": "string",
    • "personalizationFactor": 0,
    • "searchChildProductsByDefault": true
    }

    Deletes the SiteSearchSettings for a specific SearchSetting

    Authorizations:
    bearerAuthclientOauth2
    path Parameters
    name
    required
    string Nullable

    Responses